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

avi.Apipath

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.Apipath” sidebar_current: “docs-avi-resource-apipath” description: |- Creates and manages Avi ApiPath.

    avi.Apipath

    The ApiPath resource allows the creation and management of Avi ApiPath

    Example Usage

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

const foo = new avi.Apipath("foo", {
    name: "terraform-example-foo",
    tenantRef: "/api/tenant/?name=admin",
});

    import pulumi
import pulumi_avi as avi

foo = avi.Apipath("foo",
    name="terraform-example-foo",
    tenant_ref="/api/tenant/?name=admin")

    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.NewApipath(ctx, "foo", &avi.ApipathArgs{
			Name:      pulumi.String("terraform-example-foo"),
			TenantRef: pulumi.String("/api/tenant/?name=admin"),
		})
		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 foo = new Avi.Apipath("foo", new()
    {
        Name = "terraform-example-foo",
        TenantRef = "/api/tenant/?name=admin",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Apipath;
import com.pulumi.avi.ApipathArgs;
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) {
        var foo = new Apipath("foo", ApipathArgs.builder()
            .name("terraform-example-foo")
            .tenantRef("/api/tenant/?name=admin")
            .build());

    }
}

    resources:
  foo:
    type: avi:Apipath
    properties:
      name: terraform-example-foo
      tenantRef: /api/tenant/?name=admin

    Example coming soon!

    Create Apipath Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Apipath(name: string, args: ApipathArgs, opts?: CustomResourceOptions);
    @overload
def Apipath(resource_name: str,
            args: ApipathArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Apipath(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            path_template: Optional[str] = None,
            apipath_id: Optional[str] = None,
            configpb_attributes: Optional[Sequence[ApipathConfigpbAttributeArgs]] = None,
            description: Optional[str] = None,
            endpoints: Optional[Sequence[ApipathEndpointArgs]] = None,
            name: Optional[str] = None,
            source: Optional[str] = None,
            tenant_ref: Optional[str] = None,
            unknown_http_method_action: Optional[str] = None,
            uuid: Optional[str] = None)
    func NewApipath(ctx *Context, name string, args ApipathArgs, opts ...ResourceOption) (*Apipath, error)
    public Apipath(string name, ApipathArgs args, CustomResourceOptions? opts = null)
    public Apipath(String name, ApipathArgs args)
public Apipath(String name, ApipathArgs args, CustomResourceOptions options)

    type: avi:Apipath
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "avi_apipath" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ApipathArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApipathArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApipathArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApipathArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApipathArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var apipathResource = new Avi.Apipath("apipathResource", new()
{
    PathTemplate = "string",
    ApipathId = "string",
    ConfigpbAttributes = new[]
    {
        new Avi.Inputs.ApipathConfigpbAttributeArgs
        {
            CreatedBy = "string",
            Version = "string",
        },
    },
    Description = "string",
    Endpoints = new[]
    {
        new Avi.Inputs.ApipathEndpointArgs
        {
            HttpMethod = "string",
            OperationId = "string",
            PathParameters = new[]
            {
                new Avi.Inputs.ApipathEndpointPathParameterArgs
                {
                    Name = "string",
                    Schemas = new[]
                    {
                        new Avi.Inputs.ApipathEndpointPathParameterSchemaArgs
                        {
                            MaxValue = "string",
                            MinValue = "string",
                            SchemaRef = "string",
                            StringEnumValues = new[]
                            {
                                "string",
                            },
                            StringFormat = "string",
                            StringMaxLength = "string",
                            StringMinLength = "string",
                            StringPattern = "string",
                            Type = "string",
                        },
                    },
                    AllowEmptyValue = "string",
                    Deprecated = "string",
                    Required = "string",
                },
            },
            FailedValidationHeaderParameterAction = "string",
            FailedValidationPathParameterAction = "string",
            FailedValidationQueryParameterAction = "string",
            HeaderParameters = new[]
            {
                new Avi.Inputs.ApipathEndpointHeaderParameterArgs
                {
                    Name = "string",
                    Schemas = new[]
                    {
                        new Avi.Inputs.ApipathEndpointHeaderParameterSchemaArgs
                        {
                            MaxValue = "string",
                            MinValue = "string",
                            SchemaRef = "string",
                            StringEnumValues = new[]
                            {
                                "string",
                            },
                            StringFormat = "string",
                            StringMaxLength = "string",
                            StringMinLength = "string",
                            StringPattern = "string",
                            Type = "string",
                        },
                    },
                    AllowEmptyValue = "string",
                    Deprecated = "string",
                    Required = "string",
                },
            },
            Description = "string",
            Deactivated = "string",
            OverrideGlobalActiveApiLabels = "string",
            ActiveApiLabels = new[]
            {
                new Avi.Inputs.ApipathEndpointActiveApiLabelArgs
                {
                    Enabled = "string",
                    Labels = new[]
                    {
                        "string",
                    },
                },
            },
            QueryParameters = new[]
            {
                new Avi.Inputs.ApipathEndpointQueryParameterArgs
                {
                    Name = "string",
                    Schemas = new[]
                    {
                        new Avi.Inputs.ApipathEndpointQueryParameterSchemaArgs
                        {
                            MaxValue = "string",
                            MinValue = "string",
                            SchemaRef = "string",
                            StringEnumValues = new[]
                            {
                                "string",
                            },
                            StringFormat = "string",
                            StringMaxLength = "string",
                            StringMinLength = "string",
                            StringPattern = "string",
                            Type = "string",
                        },
                    },
                    AllowEmptyValue = "string",
                    Deprecated = "string",
                    Required = "string",
                },
            },
            RequestBodies = new[]
            {
                new Avi.Inputs.ApipathEndpointRequestBodyArgs
                {
                    Description = "string",
                    FailedValidationRequestBodyAction = "string",
                    Mappings = new[]
                    {
                        new Avi.Inputs.ApipathEndpointRequestBodyMappingArgs
                        {
                            ContentType = "string",
                            Schemas = new[]
                            {
                                new Avi.Inputs.ApipathEndpointRequestBodyMappingSchemaArgs
                                {
                                    MaxValue = "string",
                                    MinValue = "string",
                                    SchemaRef = "string",
                                    StringEnumValues = new[]
                                    {
                                        "string",
                                    },
                                    StringFormat = "string",
                                    StringMaxLength = "string",
                                    StringMinLength = "string",
                                    StringPattern = "string",
                                    Type = "string",
                                },
                            },
                        },
                    },
                    Required = "string",
                    UnknownContentTypeAction = "string",
                },
            },
            Responses = new[]
            {
                new Avi.Inputs.ApipathEndpointResponseArgs
                {
                    StatusCodes = new[]
                    {
                        new Avi.Inputs.ApipathEndpointResponseStatusCodeArgs
                        {
                            MatchCriteria = "string",
                            Ranges = new[]
                            {
                                new Avi.Inputs.ApipathEndpointResponseStatusCodeRangeArgs
                                {
                                    Begin = "string",
                                    End = "string",
                                },
                            },
                            StatusCodes = new[]
                            {
                                0.0,
                            },
                        },
                    },
                    ContentTypeMappings = new[]
                    {
                        new Avi.Inputs.ApipathEndpointResponseContentTypeMappingArgs
                        {
                            ContentType = "string",
                            Schemas = new[]
                            {
                                new Avi.Inputs.ApipathEndpointResponseContentTypeMappingSchemaArgs
                                {
                                    MaxValue = "string",
                                    MinValue = "string",
                                    SchemaRef = "string",
                                    StringEnumValues = new[]
                                    {
                                        "string",
                                    },
                                    StringFormat = "string",
                                    StringMaxLength = "string",
                                    StringMinLength = "string",
                                    StringPattern = "string",
                                    Type = "string",
                                },
                            },
                        },
                    },
                    Description = "string",
                    ResponseHeaderParameters = new[]
                    {
                        new Avi.Inputs.ApipathEndpointResponseResponseHeaderParameterArgs
                        {
                            Name = "string",
                            Schemas = new[]
                            {
                                new Avi.Inputs.ApipathEndpointResponseResponseHeaderParameterSchemaArgs
                                {
                                    MaxValue = "string",
                                    MinValue = "string",
                                    SchemaRef = "string",
                                    StringEnumValues = new[]
                                    {
                                        "string",
                                    },
                                    StringFormat = "string",
                                    StringMaxLength = "string",
                                    StringMinLength = "string",
                                    StringPattern = "string",
                                    Type = "string",
                                },
                            },
                            AllowEmptyValue = "string",
                            Deprecated = "string",
                            Required = "string",
                        },
                    },
                    UnknownContentTypeAction = "string",
                },
            },
            Source = "string",
            Type = "string",
            UnknownStatusCodeAction = "string",
        },
    },
    Name = "string",
    Source = "string",
    TenantRef = "string",
    UnknownHttpMethodAction = "string",
    Uuid = "string",
});

    example, err := avi.NewApipath(ctx, "apipathResource", &avi.ApipathArgs{
	PathTemplate: pulumi.String("string"),
	ApipathId:    pulumi.String("string"),
	ConfigpbAttributes: avi.ApipathConfigpbAttributeArray{
		&avi.ApipathConfigpbAttributeArgs{
			CreatedBy: pulumi.String("string"),
			Version:   pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Endpoints: avi.ApipathEndpointArray{
		&avi.ApipathEndpointArgs{
			HttpMethod:  pulumi.String("string"),
			OperationId: pulumi.String("string"),
			PathParameters: avi.ApipathEndpointPathParameterArray{
				&avi.ApipathEndpointPathParameterArgs{
					Name: pulumi.String("string"),
					Schemas: avi.ApipathEndpointPathParameterSchemaArray{
						&avi.ApipathEndpointPathParameterSchemaArgs{
							MaxValue:  pulumi.String("string"),
							MinValue:  pulumi.String("string"),
							SchemaRef: pulumi.String("string"),
							StringEnumValues: pulumi.StringArray{
								pulumi.String("string"),
							},
							StringFormat:    pulumi.String("string"),
							StringMaxLength: pulumi.String("string"),
							StringMinLength: pulumi.String("string"),
							StringPattern:   pulumi.String("string"),
							Type:            pulumi.String("string"),
						},
					},
					AllowEmptyValue: pulumi.String("string"),
					Deprecated:      pulumi.String("string"),
					Required:        pulumi.String("string"),
				},
			},
			FailedValidationHeaderParameterAction: pulumi.String("string"),
			FailedValidationPathParameterAction:   pulumi.String("string"),
			FailedValidationQueryParameterAction:  pulumi.String("string"),
			HeaderParameters: avi.ApipathEndpointHeaderParameterArray{
				&avi.ApipathEndpointHeaderParameterArgs{
					Name: pulumi.String("string"),
					Schemas: avi.ApipathEndpointHeaderParameterSchemaArray{
						&avi.ApipathEndpointHeaderParameterSchemaArgs{
							MaxValue:  pulumi.String("string"),
							MinValue:  pulumi.String("string"),
							SchemaRef: pulumi.String("string"),
							StringEnumValues: pulumi.StringArray{
								pulumi.String("string"),
							},
							StringFormat:    pulumi.String("string"),
							StringMaxLength: pulumi.String("string"),
							StringMinLength: pulumi.String("string"),
							StringPattern:   pulumi.String("string"),
							Type:            pulumi.String("string"),
						},
					},
					AllowEmptyValue: pulumi.String("string"),
					Deprecated:      pulumi.String("string"),
					Required:        pulumi.String("string"),
				},
			},
			Description:                   pulumi.String("string"),
			Deactivated:                   pulumi.String("string"),
			OverrideGlobalActiveApiLabels: pulumi.String("string"),
			ActiveApiLabels: avi.ApipathEndpointActiveApiLabelArray{
				&avi.ApipathEndpointActiveApiLabelArgs{
					Enabled: pulumi.String("string"),
					Labels: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
			QueryParameters: avi.ApipathEndpointQueryParameterArray{
				&avi.ApipathEndpointQueryParameterArgs{
					Name: pulumi.String("string"),
					Schemas: avi.ApipathEndpointQueryParameterSchemaArray{
						&avi.ApipathEndpointQueryParameterSchemaArgs{
							MaxValue:  pulumi.String("string"),
							MinValue:  pulumi.String("string"),
							SchemaRef: pulumi.String("string"),
							StringEnumValues: pulumi.StringArray{
								pulumi.String("string"),
							},
							StringFormat:    pulumi.String("string"),
							StringMaxLength: pulumi.String("string"),
							StringMinLength: pulumi.String("string"),
							StringPattern:   pulumi.String("string"),
							Type:            pulumi.String("string"),
						},
					},
					AllowEmptyValue: pulumi.String("string"),
					Deprecated:      pulumi.String("string"),
					Required:        pulumi.String("string"),
				},
			},
			RequestBodies: avi.ApipathEndpointRequestBodyArray{
				&avi.ApipathEndpointRequestBodyArgs{
					Description:                       pulumi.String("string"),
					FailedValidationRequestBodyAction: pulumi.String("string"),
					Mappings: avi.ApipathEndpointRequestBodyMappingArray{
						&avi.ApipathEndpointRequestBodyMappingArgs{
							ContentType: pulumi.String("string"),
							Schemas: avi.ApipathEndpointRequestBodyMappingSchemaArray{
								&avi.ApipathEndpointRequestBodyMappingSchemaArgs{
									MaxValue:  pulumi.String("string"),
									MinValue:  pulumi.String("string"),
									SchemaRef: pulumi.String("string"),
									StringEnumValues: pulumi.StringArray{
										pulumi.String("string"),
									},
									StringFormat:    pulumi.String("string"),
									StringMaxLength: pulumi.String("string"),
									StringMinLength: pulumi.String("string"),
									StringPattern:   pulumi.String("string"),
									Type:            pulumi.String("string"),
								},
							},
						},
					},
					Required:                 pulumi.String("string"),
					UnknownContentTypeAction: pulumi.String("string"),
				},
			},
			Responses: avi.ApipathEndpointResponseArray{
				&avi.ApipathEndpointResponseArgs{
					StatusCodes: avi.ApipathEndpointResponseStatusCodeArray{
						&avi.ApipathEndpointResponseStatusCodeArgs{
							MatchCriteria: pulumi.String("string"),
							Ranges: avi.ApipathEndpointResponseStatusCodeRangeArray{
								&avi.ApipathEndpointResponseStatusCodeRangeArgs{
									Begin: pulumi.String("string"),
									End:   pulumi.String("string"),
								},
							},
							StatusCodes: pulumi.Float64Array{
								pulumi.Float64(0),
							},
						},
					},
					ContentTypeMappings: avi.ApipathEndpointResponseContentTypeMappingArray{
						&avi.ApipathEndpointResponseContentTypeMappingArgs{
							ContentType: pulumi.String("string"),
							Schemas: avi.ApipathEndpointResponseContentTypeMappingSchemaArray{
								&avi.ApipathEndpointResponseContentTypeMappingSchemaArgs{
									MaxValue:  pulumi.String("string"),
									MinValue:  pulumi.String("string"),
									SchemaRef: pulumi.String("string"),
									StringEnumValues: pulumi.StringArray{
										pulumi.String("string"),
									},
									StringFormat:    pulumi.String("string"),
									StringMaxLength: pulumi.String("string"),
									StringMinLength: pulumi.String("string"),
									StringPattern:   pulumi.String("string"),
									Type:            pulumi.String("string"),
								},
							},
						},
					},
					Description: pulumi.String("string"),
					ResponseHeaderParameters: avi.ApipathEndpointResponseResponseHeaderParameterArray{
						&avi.ApipathEndpointResponseResponseHeaderParameterArgs{
							Name: pulumi.String("string"),
							Schemas: avi.ApipathEndpointResponseResponseHeaderParameterSchemaArray{
								&avi.ApipathEndpointResponseResponseHeaderParameterSchemaArgs{
									MaxValue:  pulumi.String("string"),
									MinValue:  pulumi.String("string"),
									SchemaRef: pulumi.String("string"),
									StringEnumValues: pulumi.StringArray{
										pulumi.String("string"),
									},
									StringFormat:    pulumi.String("string"),
									StringMaxLength: pulumi.String("string"),
									StringMinLength: pulumi.String("string"),
									StringPattern:   pulumi.String("string"),
									Type:            pulumi.String("string"),
								},
							},
							AllowEmptyValue: pulumi.String("string"),
							Deprecated:      pulumi.String("string"),
							Required:        pulumi.String("string"),
						},
					},
					UnknownContentTypeAction: pulumi.String("string"),
				},
			},
			Source:                  pulumi.String("string"),
			Type:                    pulumi.String("string"),
			UnknownStatusCodeAction: pulumi.String("string"),
		},
	},
	Name:                    pulumi.String("string"),
	Source:                  pulumi.String("string"),
	TenantRef:               pulumi.String("string"),
	UnknownHttpMethodAction: pulumi.String("string"),
	Uuid:                    pulumi.String("string"),
})

    resource "avi_apipath" "apipathResource" {
  lifecycle {
    create_before_destroy = true
  }
  path_template = "string"
  apipath_id    = "string"
  configpb_attributes {
    created_by = "string"
    version    = "string"
  }
  description = "string"
  endpoints {
    http_method  = "string"
    operation_id = "string"
    path_parameters {
      name = "string"
      schemas {
        max_value          = "string"
        min_value          = "string"
        schema_ref         = "string"
        string_enum_values = ["string"]
        string_format      = "string"
        string_max_length  = "string"
        string_min_length  = "string"
        string_pattern     = "string"
        type               = "string"
      }
      allow_empty_value = "string"
      deprecated        = "string"
      required          = "string"
    }
    failed_validation_header_parameter_action = "string"
    failed_validation_path_parameter_action   = "string"
    failed_validation_query_parameter_action  = "string"
    header_parameters {
      name = "string"
      schemas {
        max_value          = "string"
        min_value          = "string"
        schema_ref         = "string"
        string_enum_values = ["string"]
        string_format      = "string"
        string_max_length  = "string"
        string_min_length  = "string"
        string_pattern     = "string"
        type               = "string"
      }
      allow_empty_value = "string"
      deprecated        = "string"
      required          = "string"
    }
    description                       = "string"
    deactivated                       = "string"
    override_global_active_api_labels = "string"
    active_api_labels {
      enabled = "string"
      labels  = ["string"]
    }
    query_parameters {
      name = "string"
      schemas {
        max_value          = "string"
        min_value          = "string"
        schema_ref         = "string"
        string_enum_values = ["string"]
        string_format      = "string"
        string_max_length  = "string"
        string_min_length  = "string"
        string_pattern     = "string"
        type               = "string"
      }
      allow_empty_value = "string"
      deprecated        = "string"
      required          = "string"
    }
    request_bodies {
      description                           = "string"
      failed_validation_request_body_action = "string"
      mappings {
        content_type = "string"
        schemas {
          max_value          = "string"
          min_value          = "string"
          schema_ref         = "string"
          string_enum_values = ["string"]
          string_format      = "string"
          string_max_length  = "string"
          string_min_length  = "string"
          string_pattern     = "string"
          type               = "string"
        }
      }
      required                    = "string"
      unknown_content_type_action = "string"
    }
    responses {
      status_codes {
        match_criteria = "string"
        ranges {
          begin = "string"
          end   = "string"
        }
        status_codes = [0]
      }
      content_type_mappings {
        content_type = "string"
        schemas {
          max_value          = "string"
          min_value          = "string"
          schema_ref         = "string"
          string_enum_values = ["string"]
          string_format      = "string"
          string_max_length  = "string"
          string_min_length  = "string"
          string_pattern     = "string"
          type               = "string"
        }
      }
      description = "string"
      response_header_parameters {
        name = "string"
        schemas {
          max_value          = "string"
          min_value          = "string"
          schema_ref         = "string"
          string_enum_values = ["string"]
          string_format      = "string"
          string_max_length  = "string"
          string_min_length  = "string"
          string_pattern     = "string"
          type               = "string"
        }
        allow_empty_value = "string"
        deprecated        = "string"
        required          = "string"
      }
      unknown_content_type_action = "string"
    }
    source                     = "string"
    type                       = "string"
    unknown_status_code_action = "string"
  }
  name                       = "string"
  source                     = "string"
  tenant_ref                 = "string"
  unknown_http_method_action = "string"
  uuid                       = "string"
}

    var apipathResource = new Apipath("apipathResource", ApipathArgs.builder()
    .pathTemplate("string")
    .apipathId("string")
    .configpbAttributes(ApipathConfigpbAttributeArgs.builder()
        .createdBy("string")
        .version("string")
        .build())
    .description("string")
    .endpoints(ApipathEndpointArgs.builder()
        .httpMethod("string")
        .operationId("string")
        .pathParameters(ApipathEndpointPathParameterArgs.builder()
            .name("string")
            .schemas(ApipathEndpointPathParameterSchemaArgs.builder()
                .maxValue("string")
                .minValue("string")
                .schemaRef("string")
                .stringEnumValues("string")
                .stringFormat("string")
                .stringMaxLength("string")
                .stringMinLength("string")
                .stringPattern("string")
                .type("string")
                .build())
            .allowEmptyValue("string")
            .deprecated("string")
            .required("string")
            .build())
        .failedValidationHeaderParameterAction("string")
        .failedValidationPathParameterAction("string")
        .failedValidationQueryParameterAction("string")
        .headerParameters(ApipathEndpointHeaderParameterArgs.builder()
            .name("string")
            .schemas(ApipathEndpointHeaderParameterSchemaArgs.builder()
                .maxValue("string")
                .minValue("string")
                .schemaRef("string")
                .stringEnumValues("string")
                .stringFormat("string")
                .stringMaxLength("string")
                .stringMinLength("string")
                .stringPattern("string")
                .type("string")
                .build())
            .allowEmptyValue("string")
            .deprecated("string")
            .required("string")
            .build())
        .description("string")
        .deactivated("string")
        .overrideGlobalActiveApiLabels("string")
        .activeApiLabels(ApipathEndpointActiveApiLabelArgs.builder()
            .enabled("string")
            .labels("string")
            .build())
        .queryParameters(ApipathEndpointQueryParameterArgs.builder()
            .name("string")
            .schemas(ApipathEndpointQueryParameterSchemaArgs.builder()
                .maxValue("string")
                .minValue("string")
                .schemaRef("string")
                .stringEnumValues("string")
                .stringFormat("string")
                .stringMaxLength("string")
                .stringMinLength("string")
                .stringPattern("string")
                .type("string")
                .build())
            .allowEmptyValue("string")
            .deprecated("string")
            .required("string")
            .build())
        .requestBodies(ApipathEndpointRequestBodyArgs.builder()
            .description("string")
            .failedValidationRequestBodyAction("string")
            .mappings(ApipathEndpointRequestBodyMappingArgs.builder()
                .contentType("string")
                .schemas(ApipathEndpointRequestBodyMappingSchemaArgs.builder()
                    .maxValue("string")
                    .minValue("string")
                    .schemaRef("string")
                    .stringEnumValues("string")
                    .stringFormat("string")
                    .stringMaxLength("string")
                    .stringMinLength("string")
                    .stringPattern("string")
                    .type("string")
                    .build())
                .build())
            .required("string")
            .unknownContentTypeAction("string")
            .build())
        .responses(ApipathEndpointResponseArgs.builder()
            .statusCodes(ApipathEndpointResponseStatusCodeArgs.builder()
                .matchCriteria("string")
                .ranges(ApipathEndpointResponseStatusCodeRangeArgs.builder()
                    .begin("string")
                    .end("string")
                    .build())
                .statusCodes(0.0)
                .build())
            .contentTypeMappings(ApipathEndpointResponseContentTypeMappingArgs.builder()
                .contentType("string")
                .schemas(ApipathEndpointResponseContentTypeMappingSchemaArgs.builder()
                    .maxValue("string")
                    .minValue("string")
                    .schemaRef("string")
                    .stringEnumValues("string")
                    .stringFormat("string")
                    .stringMaxLength("string")
                    .stringMinLength("string")
                    .stringPattern("string")
                    .type("string")
                    .build())
                .build())
            .description("string")
            .responseHeaderParameters(ApipathEndpointResponseResponseHeaderParameterArgs.builder()
                .name("string")
                .schemas(ApipathEndpointResponseResponseHeaderParameterSchemaArgs.builder()
                    .maxValue("string")
                    .minValue("string")
                    .schemaRef("string")
                    .stringEnumValues("string")
                    .stringFormat("string")
                    .stringMaxLength("string")
                    .stringMinLength("string")
                    .stringPattern("string")
                    .type("string")
                    .build())
                .allowEmptyValue("string")
                .deprecated("string")
                .required("string")
                .build())
            .unknownContentTypeAction("string")
            .build())
        .source("string")
        .type("string")
        .unknownStatusCodeAction("string")
        .build())
    .name("string")
    .source("string")
    .tenantRef("string")
    .unknownHttpMethodAction("string")
    .uuid("string")
    .build());

    apipath_resource = avi.Apipath("apipathResource",
    path_template="string",
    apipath_id="string",
    configpb_attributes=[{
        "created_by": "string",
        "version": "string",
    }],
    description="string",
    endpoints=[{
        "http_method": "string",
        "operation_id": "string",
        "path_parameters": [{
            "name": "string",
            "schemas": [{
                "max_value": "string",
                "min_value": "string",
                "schema_ref": "string",
                "string_enum_values": ["string"],
                "string_format": "string",
                "string_max_length": "string",
                "string_min_length": "string",
                "string_pattern": "string",
                "type": "string",
            }],
            "allow_empty_value": "string",
            "deprecated": "string",
            "required": "string",
        }],
        "failed_validation_header_parameter_action": "string",
        "failed_validation_path_parameter_action": "string",
        "failed_validation_query_parameter_action": "string",
        "header_parameters": [{
            "name": "string",
            "schemas": [{
                "max_value": "string",
                "min_value": "string",
                "schema_ref": "string",
                "string_enum_values": ["string"],
                "string_format": "string",
                "string_max_length": "string",
                "string_min_length": "string",
                "string_pattern": "string",
                "type": "string",
            }],
            "allow_empty_value": "string",
            "deprecated": "string",
            "required": "string",
        }],
        "description": "string",
        "deactivated": "string",
        "override_global_active_api_labels": "string",
        "active_api_labels": [{
            "enabled": "string",
            "labels": ["string"],
        }],
        "query_parameters": [{
            "name": "string",
            "schemas": [{
                "max_value": "string",
                "min_value": "string",
                "schema_ref": "string",
                "string_enum_values": ["string"],
                "string_format": "string",
                "string_max_length": "string",
                "string_min_length": "string",
                "string_pattern": "string",
                "type": "string",
            }],
            "allow_empty_value": "string",
            "deprecated": "string",
            "required": "string",
        }],
        "request_bodies": [{
            "description": "string",
            "failed_validation_request_body_action": "string",
            "mappings": [{
                "content_type": "string",
                "schemas": [{
                    "max_value": "string",
                    "min_value": "string",
                    "schema_ref": "string",
                    "string_enum_values": ["string"],
                    "string_format": "string",
                    "string_max_length": "string",
                    "string_min_length": "string",
                    "string_pattern": "string",
                    "type": "string",
                }],
            }],
            "required": "string",
            "unknown_content_type_action": "string",
        }],
        "responses": [{
            "status_codes": [{
                "match_criteria": "string",
                "ranges": [{
                    "begin": "string",
                    "end": "string",
                }],
                "status_codes": [float(0)],
            }],
            "content_type_mappings": [{
                "content_type": "string",
                "schemas": [{
                    "max_value": "string",
                    "min_value": "string",
                    "schema_ref": "string",
                    "string_enum_values": ["string"],
                    "string_format": "string",
                    "string_max_length": "string",
                    "string_min_length": "string",
                    "string_pattern": "string",
                    "type": "string",
                }],
            }],
            "description": "string",
            "response_header_parameters": [{
                "name": "string",
                "schemas": [{
                    "max_value": "string",
                    "min_value": "string",
                    "schema_ref": "string",
                    "string_enum_values": ["string"],
                    "string_format": "string",
                    "string_max_length": "string",
                    "string_min_length": "string",
                    "string_pattern": "string",
                    "type": "string",
                }],
                "allow_empty_value": "string",
                "deprecated": "string",
                "required": "string",
            }],
            "unknown_content_type_action": "string",
        }],
        "source": "string",
        "type": "string",
        "unknown_status_code_action": "string",
    }],
    name="string",
    source="string",
    tenant_ref="string",
    unknown_http_method_action="string",
    uuid="string")

    const apipathResource = new avi.Apipath("apipathResource", {
    pathTemplate: "string",
    apipathId: "string",
    configpbAttributes: [{
        createdBy: "string",
        version: "string",
    }],
    description: "string",
    endpoints: [{
        httpMethod: "string",
        operationId: "string",
        pathParameters: [{
            name: "string",
            schemas: [{
                maxValue: "string",
                minValue: "string",
                schemaRef: "string",
                stringEnumValues: ["string"],
                stringFormat: "string",
                stringMaxLength: "string",
                stringMinLength: "string",
                stringPattern: "string",
                type: "string",
            }],
            allowEmptyValue: "string",
            deprecated: "string",
            required: "string",
        }],
        failedValidationHeaderParameterAction: "string",
        failedValidationPathParameterAction: "string",
        failedValidationQueryParameterAction: "string",
        headerParameters: [{
            name: "string",
            schemas: [{
                maxValue: "string",
                minValue: "string",
                schemaRef: "string",
                stringEnumValues: ["string"],
                stringFormat: "string",
                stringMaxLength: "string",
                stringMinLength: "string",
                stringPattern: "string",
                type: "string",
            }],
            allowEmptyValue: "string",
            deprecated: "string",
            required: "string",
        }],
        description: "string",
        deactivated: "string",
        overrideGlobalActiveApiLabels: "string",
        activeApiLabels: [{
            enabled: "string",
            labels: ["string"],
        }],
        queryParameters: [{
            name: "string",
            schemas: [{
                maxValue: "string",
                minValue: "string",
                schemaRef: "string",
                stringEnumValues: ["string"],
                stringFormat: "string",
                stringMaxLength: "string",
                stringMinLength: "string",
                stringPattern: "string",
                type: "string",
            }],
            allowEmptyValue: "string",
            deprecated: "string",
            required: "string",
        }],
        requestBodies: [{
            description: "string",
            failedValidationRequestBodyAction: "string",
            mappings: [{
                contentType: "string",
                schemas: [{
                    maxValue: "string",
                    minValue: "string",
                    schemaRef: "string",
                    stringEnumValues: ["string"],
                    stringFormat: "string",
                    stringMaxLength: "string",
                    stringMinLength: "string",
                    stringPattern: "string",
                    type: "string",
                }],
            }],
            required: "string",
            unknownContentTypeAction: "string",
        }],
        responses: [{
            statusCodes: [{
                matchCriteria: "string",
                ranges: [{
                    begin: "string",
                    end: "string",
                }],
                statusCodes: [0],
            }],
            contentTypeMappings: [{
                contentType: "string",
                schemas: [{
                    maxValue: "string",
                    minValue: "string",
                    schemaRef: "string",
                    stringEnumValues: ["string"],
                    stringFormat: "string",
                    stringMaxLength: "string",
                    stringMinLength: "string",
                    stringPattern: "string",
                    type: "string",
                }],
            }],
            description: "string",
            responseHeaderParameters: [{
                name: "string",
                schemas: [{
                    maxValue: "string",
                    minValue: "string",
                    schemaRef: "string",
                    stringEnumValues: ["string"],
                    stringFormat: "string",
                    stringMaxLength: "string",
                    stringMinLength: "string",
                    stringPattern: "string",
                    type: "string",
                }],
                allowEmptyValue: "string",
                deprecated: "string",
                required: "string",
            }],
            unknownContentTypeAction: "string",
        }],
        source: "string",
        type: "string",
        unknownStatusCodeAction: "string",
    }],
    name: "string",
    source: "string",
    tenantRef: "string",
    unknownHttpMethodAction: "string",
    uuid: "string",
});

    type: avi:Apipath
properties:
    apipathId: string
    configpbAttributes:
        - createdBy: string
          version: string
    description: string
    endpoints:
        - activeApiLabels:
            - enabled: string
              labels:
                - string
          deactivated: string
          description: string
          failedValidationHeaderParameterAction: string
          failedValidationPathParameterAction: string
          failedValidationQueryParameterAction: string
          headerParameters:
            - allowEmptyValue: string
              deprecated: string
              name: string
              required: string
              schemas:
                - maxValue: string
                  minValue: string
                  schemaRef: string
                  stringEnumValues:
                    - string
                  stringFormat: string
                  stringMaxLength: string
                  stringMinLength: string
                  stringPattern: string
                  type: string
          httpMethod: string
          operationId: string
          overrideGlobalActiveApiLabels: string
          pathParameters:
            - allowEmptyValue: string
              deprecated: string
              name: string
              required: string
              schemas:
                - maxValue: string
                  minValue: string
                  schemaRef: string
                  stringEnumValues:
                    - string
                  stringFormat: string
                  stringMaxLength: string
                  stringMinLength: string
                  stringPattern: string
                  type: string
          queryParameters:
            - allowEmptyValue: string
              deprecated: string
              name: string
              required: string
              schemas:
                - maxValue: string
                  minValue: string
                  schemaRef: string
                  stringEnumValues:
                    - string
                  stringFormat: string
                  stringMaxLength: string
                  stringMinLength: string
                  stringPattern: string
                  type: string
          requestBodies:
            - description: string
              failedValidationRequestBodyAction: string
              mappings:
                - contentType: string
                  schemas:
                    - maxValue: string
                      minValue: string
                      schemaRef: string
                      stringEnumValues:
                        - string
                      stringFormat: string
                      stringMaxLength: string
                      stringMinLength: string
                      stringPattern: string
                      type: string
              required: string
              unknownContentTypeAction: string
          responses:
            - contentTypeMappings:
                - contentType: string
                  schemas:
                    - maxValue: string
                      minValue: string
                      schemaRef: string
                      stringEnumValues:
                        - string
                      stringFormat: string
                      stringMaxLength: string
                      stringMinLength: string
                      stringPattern: string
                      type: string
              description: string
              responseHeaderParameters:
                - allowEmptyValue: string
                  deprecated: string
                  name: string
                  required: string
                  schemas:
                    - maxValue: string
                      minValue: string
                      schemaRef: string
                      stringEnumValues:
                        - string
                      stringFormat: string
                      stringMaxLength: string
                      stringMinLength: string
                      stringPattern: string
                      type: string
              statusCodes:
                - matchCriteria: string
                  ranges:
                    - begin: string
                      end: string
                  statusCodes:
                    - 0
              unknownContentTypeAction: string
          source: string
          type: string
          unknownStatusCodeAction: string
    name: string
    pathTemplate: string
    source: string
    tenantRef: string
    unknownHttpMethodAction: string
    uuid: string

    Apipath Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Apipath resource accepts the following input properties:

    PathTemplate string
    The uri path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition. Changing this value forces the resource to be recreated.
    ApipathId string
    ConfigpbAttributes List<ApipathConfigpbAttribute>
    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 path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Endpoints List<ApipathEndpoint>
    List of api endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. 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.
    Source string
    Indicates whether this path 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.
    UnknownHttpMethodAction string
    Action to take when a request matches this path but uses an http method not defined for this path. Overrides the policy-level unknown_http_method_action when not inherit. 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.
    Uuid string
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PathTemplate string
    The uri path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition. Changing this value forces the resource to be recreated.
    ApipathId string
    ConfigpbAttributes []ApipathConfigpbAttributeArgs
    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 path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Endpoints []ApipathEndpointArgs
    List of api endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. 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.
    Source string
    Indicates whether this path 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.
    UnknownHttpMethodAction string
    Action to take when a request matches this path but uses an http method not defined for this path. Overrides the policy-level unknown_http_method_action when not inherit. 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.
    Uuid string
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    path_template string
    The uri path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition. Changing this value forces the resource to be recreated.
    apipath_id string
    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 path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endpoints list(object)
    List of api endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. 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.
    source string
    Indicates whether this path 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.
    unknown_http_method_action string
    Action to take when a request matches this path but uses an http method not defined for this path. Overrides the policy-level unknown_http_method_action when not inherit. 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.
    uuid string
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pathTemplate String
    The uri path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition. Changing this value forces the resource to be recreated.
    apipathId String
    configpbAttributes List<ApipathConfigpbAttribute>
    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 path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endpoints List<ApipathEndpoint>
    List of api endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. 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.
    source String
    Indicates whether this path 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.
    unknownHttpMethodAction String
    Action to take when a request matches this path but uses an http method not defined for this path. Overrides the policy-level unknown_http_method_action when not inherit. 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.
    uuid String
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pathTemplate string
    The uri path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition. Changing this value forces the resource to be recreated.
    apipathId string
    configpbAttributes ApipathConfigpbAttribute[]
    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 path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endpoints ApipathEndpoint[]
    List of api endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. 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.
    source string
    Indicates whether this path 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.
    unknownHttpMethodAction string
    Action to take when a request matches this path but uses an http method not defined for this path. Overrides the policy-level unknown_http_method_action when not inherit. 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.
    uuid string
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    path_template str
    The uri path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition. Changing this value forces the resource to be recreated.
    apipath_id str
    configpb_attributes Sequence[ApipathConfigpbAttributeArgs]
    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 path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endpoints Sequence[ApipathEndpointArgs]
    List of api endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. 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.
    source str
    Indicates whether this path 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.
    unknown_http_method_action str
    Action to take when a request matches this path but uses an http method not defined for this path. Overrides the policy-level unknown_http_method_action when not inherit. 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.
    uuid str
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pathTemplate String
    The uri path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition. Changing this value forces the resource to be recreated.
    apipathId String
    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 path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endpoints List<Property Map>
    List of api endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. 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.
    source String
    Indicates whether this path 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.
    unknownHttpMethodAction String
    Action to take when a request matches this path but uses an http method not defined for this path. Overrides the policy-level unknown_http_method_action when not inherit. 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.
    uuid String
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Apipath resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Apipath Resource

    Get an existing Apipath resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApipathState, opts?: CustomResourceOptions): Apipath
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apipath_id: Optional[str] = None,
        configpb_attributes: Optional[Sequence[ApipathConfigpbAttributeArgs]] = None,
        description: Optional[str] = None,
        endpoints: Optional[Sequence[ApipathEndpointArgs]] = None,
        name: Optional[str] = None,
        path_template: Optional[str] = None,
        source: Optional[str] = None,
        tenant_ref: Optional[str] = None,
        unknown_http_method_action: Optional[str] = None,
        uuid: Optional[str] = None) -> Apipath
    func GetApipath(ctx *Context, name string, id IDInput, state *ApipathState, opts ...ResourceOption) (*Apipath, error)
    public static Apipath Get(string name, Input<string> id, ApipathState? state, CustomResourceOptions? opts = null)
    public static Apipath get(String name, Output<String> id, ApipathState state, CustomResourceOptions options)
    resources:  _:    type: avi:Apipath    get:      id: ${id}
    import {
  to = avi_apipath.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApipathId string
    ConfigpbAttributes List<ApipathConfigpbAttribute>
    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 path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Endpoints List<ApipathEndpoint>
    List of api endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. 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.
    PathTemplate string
    The uri path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition. Changing this value forces the resource to be recreated.
    Source string
    Indicates whether this path 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.
    UnknownHttpMethodAction string
    Action to take when a request matches this path but uses an http method not defined for this path. Overrides the policy-level unknown_http_method_action when not inherit. 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.
    Uuid string
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ApipathId string
    ConfigpbAttributes []ApipathConfigpbAttributeArgs
    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 path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Endpoints []ApipathEndpointArgs
    List of api endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. 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.
    PathTemplate string
    The uri path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition. Changing this value forces the resource to be recreated.
    Source string
    Indicates whether this path 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.
    UnknownHttpMethodAction string
    Action to take when a request matches this path but uses an http method not defined for this path. Overrides the policy-level unknown_http_method_action when not inherit. 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.
    Uuid string
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    apipath_id string
    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 path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endpoints list(object)
    List of api endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. 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.
    path_template string
    The uri path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition. Changing this value forces the resource to be recreated.
    source string
    Indicates whether this path 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.
    unknown_http_method_action string
    Action to take when a request matches this path but uses an http method not defined for this path. Overrides the policy-level unknown_http_method_action when not inherit. 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.
    uuid string
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    apipathId String
    configpbAttributes List<ApipathConfigpbAttribute>
    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 path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endpoints List<ApipathEndpoint>
    List of api endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. 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.
    pathTemplate String
    The uri path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition. Changing this value forces the resource to be recreated.
    source String
    Indicates whether this path 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.
    unknownHttpMethodAction String
    Action to take when a request matches this path but uses an http method not defined for this path. Overrides the policy-level unknown_http_method_action when not inherit. 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.
    uuid String
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    apipathId string
    configpbAttributes ApipathConfigpbAttribute[]
    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 path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endpoints ApipathEndpoint[]
    List of api endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. 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.
    pathTemplate string
    The uri path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition. Changing this value forces the resource to be recreated.
    source string
    Indicates whether this path 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.
    unknownHttpMethodAction string
    Action to take when a request matches this path but uses an http method not defined for this path. Overrides the policy-level unknown_http_method_action when not inherit. 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.
    uuid string
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    apipath_id str
    configpb_attributes Sequence[ApipathConfigpbAttributeArgs]
    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 path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endpoints Sequence[ApipathEndpointArgs]
    List of api endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. 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.
    path_template str
    The uri path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition. Changing this value forces the resource to be recreated.
    source str
    Indicates whether this path 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.
    unknown_http_method_action str
    Action to take when a request matches this path but uses an http method not defined for this path. Overrides the policy-level unknown_http_method_action when not inherit. 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.
    uuid str
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    apipathId String
    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 path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endpoints List<Property Map>
    List of api endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. 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.
    pathTemplate String
    The uri path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition. Changing this value forces the resource to be recreated.
    source String
    Indicates whether this path 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.
    unknownHttpMethodAction String
    Action to take when a request matches this path but uses an http method not defined for this path. Overrides the policy-level unknown_http_method_action when not inherit. 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.
    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

    ApipathConfigpbAttribute, ApipathConfigpbAttributeArgs

    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

    ApipathEndpoint, ApipathEndpointArgs

    HttpMethod string
    ActiveApiLabels List<ApipathEndpointActiveApiLabel>
    Deactivated string
    Description string
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FailedValidationHeaderParameterAction string
    FailedValidationPathParameterAction string
    FailedValidationQueryParameterAction string
    HeaderParameters List<ApipathEndpointHeaderParameter>
    OperationId string
    OverrideGlobalActiveApiLabels string
    PathParameters List<ApipathEndpointPathParameter>
    QueryParameters List<ApipathEndpointQueryParameter>
    RequestBodies List<ApipathEndpointRequestBody>
    Responses List<ApipathEndpointResponse>
    Source string
    Indicates whether this path 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.
    Type string
    UnknownStatusCodeAction string
    HttpMethod string
    ActiveApiLabels []ApipathEndpointActiveApiLabel
    Deactivated string
    Description string
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FailedValidationHeaderParameterAction string
    FailedValidationPathParameterAction string
    FailedValidationQueryParameterAction string
    HeaderParameters []ApipathEndpointHeaderParameter
    OperationId string
    OverrideGlobalActiveApiLabels string
    PathParameters []ApipathEndpointPathParameter
    QueryParameters []ApipathEndpointQueryParameter
    RequestBodies []ApipathEndpointRequestBody
    Responses []ApipathEndpointResponse
    Source string
    Indicates whether this path 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.
    Type string
    UnknownStatusCodeAction string
    http_method string
    active_api_labels list(object)
    deactivated string
    description string
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failed_validation_header_parameter_action string
    failed_validation_path_parameter_action string
    failed_validation_query_parameter_action string
    header_parameters list(object)
    operation_id string
    override_global_active_api_labels string
    path_parameters list(object)
    query_parameters list(object)
    request_bodies list(object)
    responses list(object)
    source string
    Indicates whether this path 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.
    type string
    unknown_status_code_action string
    httpMethod String
    activeApiLabels List<ApipathEndpointActiveApiLabel>
    deactivated String
    description String
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failedValidationHeaderParameterAction String
    failedValidationPathParameterAction String
    failedValidationQueryParameterAction String
    headerParameters List<ApipathEndpointHeaderParameter>
    operationId String
    overrideGlobalActiveApiLabels String
    pathParameters List<ApipathEndpointPathParameter>
    queryParameters List<ApipathEndpointQueryParameter>
    requestBodies List<ApipathEndpointRequestBody>
    responses List<ApipathEndpointResponse>
    source String
    Indicates whether this path 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.
    type String
    unknownStatusCodeAction String
    httpMethod string
    activeApiLabels ApipathEndpointActiveApiLabel[]
    deactivated string
    description string
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failedValidationHeaderParameterAction string
    failedValidationPathParameterAction string
    failedValidationQueryParameterAction string
    headerParameters ApipathEndpointHeaderParameter[]
    operationId string
    overrideGlobalActiveApiLabels string
    pathParameters ApipathEndpointPathParameter[]
    queryParameters ApipathEndpointQueryParameter[]
    requestBodies ApipathEndpointRequestBody[]
    responses ApipathEndpointResponse[]
    source string
    Indicates whether this path 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.
    type string
    unknownStatusCodeAction string
    http_method str
    active_api_labels Sequence[ApipathEndpointActiveApiLabel]
    deactivated str
    description str
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failed_validation_header_parameter_action str
    failed_validation_path_parameter_action str
    failed_validation_query_parameter_action str
    header_parameters Sequence[ApipathEndpointHeaderParameter]
    operation_id str
    override_global_active_api_labels str
    path_parameters Sequence[ApipathEndpointPathParameter]
    query_parameters Sequence[ApipathEndpointQueryParameter]
    request_bodies Sequence[ApipathEndpointRequestBody]
    responses Sequence[ApipathEndpointResponse]
    source str
    Indicates whether this path 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.
    type str
    unknown_status_code_action str
    httpMethod String
    activeApiLabels List<Property Map>
    deactivated String
    description String
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failedValidationHeaderParameterAction String
    failedValidationPathParameterAction String
    failedValidationQueryParameterAction String
    headerParameters List<Property Map>
    operationId String
    overrideGlobalActiveApiLabels String
    pathParameters List<Property Map>
    queryParameters List<Property Map>
    requestBodies List<Property Map>
    responses List<Property Map>
    source String
    Indicates whether this path 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.
    type String
    unknownStatusCodeAction String

    ApipathEndpointActiveApiLabel, ApipathEndpointActiveApiLabelArgs

    Enabled string
    Labels List<string>
    Enabled string
    Labels []string
    enabled string
    labels list(string)
    enabled String
    labels List<String>
    enabled string
    labels string[]
    enabled str
    labels Sequence[str]
    enabled String
    labels List<String>

    ApipathEndpointHeaderParameter, ApipathEndpointHeaderParameterArgs

    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.
    Schemas List<ApipathEndpointHeaderParameterSchema>
    AllowEmptyValue string
    Deprecated string
    Required string
    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.
    Schemas []ApipathEndpointHeaderParameterSchema
    AllowEmptyValue string
    Deprecated string
    Required string
    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.
    schemas list(object)
    allow_empty_value string
    deprecated string
    required string
    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.
    schemas List<ApipathEndpointHeaderParameterSchema>
    allowEmptyValue String
    deprecated String
    required String
    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.
    schemas ApipathEndpointHeaderParameterSchema[]
    allowEmptyValue string
    deprecated string
    required string
    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.
    schemas Sequence[ApipathEndpointHeaderParameterSchema]
    allow_empty_value str
    deprecated str
    required str
    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.
    schemas List<Property Map>
    allowEmptyValue String
    deprecated String
    required String

    ApipathEndpointHeaderParameterSchema, ApipathEndpointHeaderParameterSchemaArgs

    MaxValue string
    MinValue string
    SchemaRef string
    StringEnumValues List<string>
    StringFormat string
    StringMaxLength string
    StringMinLength string
    StringPattern string
    Type string
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String

    ApipathEndpointPathParameter, ApipathEndpointPathParameterArgs

    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.
    Schemas List<ApipathEndpointPathParameterSchema>
    AllowEmptyValue string
    Deprecated string
    Required string
    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.
    Schemas []ApipathEndpointPathParameterSchema
    AllowEmptyValue string
    Deprecated string
    Required string
    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.
    schemas list(object)
    allow_empty_value string
    deprecated string
    required string
    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.
    schemas List<ApipathEndpointPathParameterSchema>
    allowEmptyValue String
    deprecated String
    required String
    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.
    schemas ApipathEndpointPathParameterSchema[]
    allowEmptyValue string
    deprecated string
    required string
    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.
    schemas Sequence[ApipathEndpointPathParameterSchema]
    allow_empty_value str
    deprecated str
    required str
    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.
    schemas List<Property Map>
    allowEmptyValue String
    deprecated String
    required String

    ApipathEndpointPathParameterSchema, ApipathEndpointPathParameterSchemaArgs

    MaxValue string
    MinValue string
    SchemaRef string
    StringEnumValues List<string>
    StringFormat string
    StringMaxLength string
    StringMinLength string
    StringPattern string
    Type string
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String

    ApipathEndpointQueryParameter, ApipathEndpointQueryParameterArgs

    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.
    Schemas List<ApipathEndpointQueryParameterSchema>
    AllowEmptyValue string
    Deprecated string
    Required string
    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.
    Schemas []ApipathEndpointQueryParameterSchema
    AllowEmptyValue string
    Deprecated string
    Required string
    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.
    schemas list(object)
    allow_empty_value string
    deprecated string
    required string
    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.
    schemas List<ApipathEndpointQueryParameterSchema>
    allowEmptyValue String
    deprecated String
    required String
    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.
    schemas ApipathEndpointQueryParameterSchema[]
    allowEmptyValue string
    deprecated string
    required string
    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.
    schemas Sequence[ApipathEndpointQueryParameterSchema]
    allow_empty_value str
    deprecated str
    required str
    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.
    schemas List<Property Map>
    allowEmptyValue String
    deprecated String
    required String

    ApipathEndpointQueryParameterSchema, ApipathEndpointQueryParameterSchemaArgs

    MaxValue string
    MinValue string
    SchemaRef string
    StringEnumValues List<string>
    StringFormat string
    StringMaxLength string
    StringMinLength string
    StringPattern string
    Type string
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String

    ApipathEndpointRequestBody, ApipathEndpointRequestBodyArgs

    Description string
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FailedValidationRequestBodyAction string
    Mappings List<ApipathEndpointRequestBodyMapping>
    Required string
    UnknownContentTypeAction string
    Description string
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FailedValidationRequestBodyAction string
    Mappings []ApipathEndpointRequestBodyMapping
    Required string
    UnknownContentTypeAction string
    description string
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failed_validation_request_body_action string
    mappings list(object)
    required string
    unknown_content_type_action string
    description String
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failedValidationRequestBodyAction String
    mappings List<ApipathEndpointRequestBodyMapping>
    required String
    unknownContentTypeAction String
    description string
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failedValidationRequestBodyAction string
    mappings ApipathEndpointRequestBodyMapping[]
    required string
    unknownContentTypeAction string
    description str
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failed_validation_request_body_action str
    mappings Sequence[ApipathEndpointRequestBodyMapping]
    required str
    unknown_content_type_action str
    description String
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failedValidationRequestBodyAction String
    mappings List<Property Map>
    required String
    unknownContentTypeAction String

    ApipathEndpointRequestBodyMapping, ApipathEndpointRequestBodyMappingArgs

    ApipathEndpointRequestBodyMappingSchema, ApipathEndpointRequestBodyMappingSchemaArgs

    MaxValue string
    MinValue string
    SchemaRef string
    StringEnumValues List<string>
    StringFormat string
    StringMaxLength string
    StringMinLength string
    StringPattern string
    Type string
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String

    ApipathEndpointResponse, ApipathEndpointResponseArgs

    StatusCodes List<ApipathEndpointResponseStatusCode>
    ContentTypeMappings List<ApipathEndpointResponseContentTypeMapping>
    Description string
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ResponseHeaderParameters List<ApipathEndpointResponseResponseHeaderParameter>
    UnknownContentTypeAction string
    StatusCodes []ApipathEndpointResponseStatusCode
    ContentTypeMappings []ApipathEndpointResponseContentTypeMapping
    Description string
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ResponseHeaderParameters []ApipathEndpointResponseResponseHeaderParameter
    UnknownContentTypeAction string
    status_codes list(object)
    content_type_mappings list(object)
    description string
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    response_header_parameters list(object)
    unknown_content_type_action string
    statusCodes List<ApipathEndpointResponseStatusCode>
    contentTypeMappings List<ApipathEndpointResponseContentTypeMapping>
    description String
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    responseHeaderParameters List<ApipathEndpointResponseResponseHeaderParameter>
    unknownContentTypeAction String
    statusCodes ApipathEndpointResponseStatusCode[]
    contentTypeMappings ApipathEndpointResponseContentTypeMapping[]
    description string
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    responseHeaderParameters ApipathEndpointResponseResponseHeaderParameter[]
    unknownContentTypeAction string
    status_codes Sequence[ApipathEndpointResponseStatusCode]
    content_type_mappings Sequence[ApipathEndpointResponseContentTypeMapping]
    description str
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    response_header_parameters Sequence[ApipathEndpointResponseResponseHeaderParameter]
    unknown_content_type_action str
    statusCodes List<Property Map>
    contentTypeMappings List<Property Map>
    description String
    Description of this api path. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    responseHeaderParameters List<Property Map>
    unknownContentTypeAction String

    ApipathEndpointResponseContentTypeMapping, ApipathEndpointResponseContentTypeMappingArgs

    ApipathEndpointResponseContentTypeMappingSchema, ApipathEndpointResponseContentTypeMappingSchemaArgs

    MaxValue string
    MinValue string
    SchemaRef string
    StringEnumValues List<string>
    StringFormat string
    StringMaxLength string
    StringMinLength string
    StringPattern string
    Type string
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String

    ApipathEndpointResponseResponseHeaderParameter, ApipathEndpointResponseResponseHeaderParameterArgs

    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.
    Schemas List<ApipathEndpointResponseResponseHeaderParameterSchema>
    AllowEmptyValue string
    Deprecated string
    Required string
    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.
    Schemas []ApipathEndpointResponseResponseHeaderParameterSchema
    AllowEmptyValue string
    Deprecated string
    Required string
    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.
    schemas list(object)
    allow_empty_value string
    deprecated string
    required string
    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.
    schemas List<ApipathEndpointResponseResponseHeaderParameterSchema>
    allowEmptyValue String
    deprecated String
    required String
    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.
    schemas ApipathEndpointResponseResponseHeaderParameterSchema[]
    allowEmptyValue string
    deprecated string
    required string
    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.
    schemas Sequence[ApipathEndpointResponseResponseHeaderParameterSchema]
    allow_empty_value str
    deprecated str
    required str
    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.
    schemas List<Property Map>
    allowEmptyValue String
    deprecated String
    required String

    ApipathEndpointResponseResponseHeaderParameterSchema, ApipathEndpointResponseResponseHeaderParameterSchemaArgs

    MaxValue string
    MinValue string
    SchemaRef string
    StringEnumValues List<string>
    StringFormat string
    StringMaxLength string
    StringMinLength string
    StringPattern string
    Type string
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String

    ApipathEndpointResponseStatusCode, ApipathEndpointResponseStatusCodeArgs

    ApipathEndpointResponseStatusCodeRange, ApipathEndpointResponseStatusCodeRangeArgs

    Begin string
    End string
    Begin string
    End string
    begin string
    end string
    begin String
    end String
    begin string
    end string
    begin str
    end str
    begin String
    end String

    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