avi 32.1.4, Oct 23 26

Viewing docs for avi 32.1.4
published on Friday, Oct 23, 2026 by vmware

avi

Viewing docs for avi 32.1.4
published on Friday, Oct 23, 2026 by vmware

<!–

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

–>

layout: “avi”

page_title: “AVI: avi.Apipath” sidebar_current: “docs-avi-datasource-apipath” description: |- Get information of Avi ApiPath.

avi.Apipath

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

Example Usage

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

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

import pulumi
import pulumi_avi as avi

foo_apipath = avi.get_apipath(uuid="apipath-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    name="foo")

package main

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

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

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

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

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.AviFunctions;
import com.pulumi.avi.inputs.GetApipathArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var fooApipath = AviFunctions.getApipath(GetApipathArgs.builder()
            .uuid("apipath-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .name("foo")
            .build());

    }
}

variables:
  fooApipath:
    fn::invoke:
      function: avi:getApipath
      arguments:
        uuid: apipath-f9cf6b3e-a411-436f-95e2-2982ba2b217b
        name: foo

Example coming soon!

Using getApipath

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

function getApipath(args: GetApipathArgs, opts?: InvokeOptions): Promise<GetApipathResult>
function getApipathOutput(args: GetApipathOutputArgs, opts?: InvokeOutputOptions): Output<GetApipathResult>

def get_apipath(id: Optional[str] = None,
                name: Optional[str] = None,
                tenant_ref: Optional[str] = None,
                uuid: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetApipathResult
def get_apipath_output(id: pulumi.Input[Optional[str]] = None,
                name: pulumi.Input[Optional[str]] = None,
                tenant_ref: pulumi.Input[Optional[str]] = None,
                uuid: pulumi.Input[Optional[str]] = None,
                opts: Optional[InvokeOutputOptions] = None) -> Output[GetApipathResult]

func LookupApipath(ctx *Context, args *LookupApipathArgs, opts ...InvokeOption) (*LookupApipathResult, error)
func LookupApipathOutput(ctx *Context, args *LookupApipathOutputArgs, opts ...InvokeOption) LookupApipathResultOutput

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

public static class GetApipath 
{
    public static Task<GetApipathResult> InvokeAsync(GetApipathArgs args, InvokeOptions? opts = null)
    public static Output<GetApipathResult> Invoke(GetApipathInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetApipathResult> Invoke(GetApipathInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetApipathResult> getApipath(GetApipathArgs args, InvokeOptions options)
public static Output<GetApipathResult> getApipath(GetApipathArgs args, InvokeOptions options)
public static Output<GetApipathResult> getApipath(GetApipathArgs args, InvokeOutputOptions options)

fn::invoke:
  function: avi:index/getApipath:getApipath
  arguments:
    # arguments dictionary

data "avi_get_apipath" "name" {
    # arguments
}

The following arguments are supported:

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

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

id string
name string: Search ApiPath by name.
tenant_ref string: It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string: Search ApiPath by uuid.

id String
name String: Search ApiPath by name.
tenantRef String: It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Search ApiPath by uuid.

id string
name string: Search ApiPath by name.
tenantRef string: It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string: Search ApiPath by uuid.

id str
name str: Search ApiPath by name.
tenant_ref str: It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str: Search ApiPath by uuid.

id String
name String: Search ApiPath by name.
tenantRef String: It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Search ApiPath by uuid.

getApipath Result

The following output properties are available:

ConfigpbAttributes List<GetApipathConfigpbAttribute>: 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<GetApipathEndpoint>: 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.
Id 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.
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.
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.

ConfigpbAttributes []GetApipathConfigpbAttribute: 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 []GetApipathEndpoint: 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.
Id 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.
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.
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.

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.
id 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.
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.
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.

configpbAttributes List<GetApipathConfigpbAttribute>: 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<GetApipathEndpoint>: 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.
id 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.
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.
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.

configpbAttributes GetApipathConfigpbAttribute[]: 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 GetApipathEndpoint[]: 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.
id 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.
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.
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.

configpb_attributes Sequence[GetApipathConfigpbAttribute]: 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[GetApipathEndpoint]: 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.
id str
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.
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.

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.
id 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.
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.
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

GetApipathConfigpbAttribute

CreatedBy string
Version string

CreatedBy string
Version string

created_by string
version string

createdBy String
version String

createdBy string
version string

created_by str
version str

createdBy String
version String

GetApipathEndpoint

ActiveApiLabels List<GetApipathEndpointActiveApiLabel>
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<GetApipathEndpointHeaderParameter>
HttpMethod string
OperationId string
OverrideGlobalActiveApiLabels string
PathParameters List<GetApipathEndpointPathParameter>
QueryParameters List<GetApipathEndpointQueryParameter>
RequestBodies List<GetApipathEndpointRequestBody>
Responses List<GetApipathEndpointResponse>
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

ActiveApiLabels []GetApipathEndpointActiveApiLabel
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 []GetApipathEndpointHeaderParameter
HttpMethod string
OperationId string
OverrideGlobalActiveApiLabels string
PathParameters []GetApipathEndpointPathParameter
QueryParameters []GetApipathEndpointQueryParameter
RequestBodies []GetApipathEndpointRequestBody
Responses []GetApipathEndpointResponse
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

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)
http_method string
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

activeApiLabels List<GetApipathEndpointActiveApiLabel>
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<GetApipathEndpointHeaderParameter>
httpMethod String
operationId String
overrideGlobalActiveApiLabels String
pathParameters List<GetApipathEndpointPathParameter>
queryParameters List<GetApipathEndpointQueryParameter>
requestBodies List<GetApipathEndpointRequestBody>
responses List<GetApipathEndpointResponse>
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

activeApiLabels GetApipathEndpointActiveApiLabel[]
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 GetApipathEndpointHeaderParameter[]
httpMethod string
operationId string
overrideGlobalActiveApiLabels string
pathParameters GetApipathEndpointPathParameter[]
queryParameters GetApipathEndpointQueryParameter[]
requestBodies GetApipathEndpointRequestBody[]
responses GetApipathEndpointResponse[]
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

active_api_labels Sequence[GetApipathEndpointActiveApiLabel]
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[GetApipathEndpointHeaderParameter]
http_method str
operation_id str
override_global_active_api_labels str
path_parameters Sequence[GetApipathEndpointPathParameter]
query_parameters Sequence[GetApipathEndpointQueryParameter]
request_bodies Sequence[GetApipathEndpointRequestBody]
responses Sequence[GetApipathEndpointResponse]
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

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>
httpMethod String
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

GetApipathEndpointActiveApiLabel

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>

GetApipathEndpointRequestBody

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<GetApipathEndpointRequestBodyMapping>
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 []GetApipathEndpointRequestBodyMapping
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<GetApipathEndpointRequestBodyMapping>
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 GetApipathEndpointRequestBodyMapping[]
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[GetApipathEndpointRequestBodyMapping]
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