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.Apipolicy” sidebar_current: “docs-avi-datasource-apipolicy” description: |- Get information of Avi ApiPolicy.

avi.Apipolicy

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

Example Usage

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

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

import pulumi
import pulumi_avi as avi

foo_apipolicy = avi.get_apipolicy(uuid="apipolicy-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.LookupApipolicy(ctx, &avi.LookupApipolicyArgs{
			Uuid: pulumi.StringRef("apipolicy-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 fooApipolicy = Avi.GetApipolicy.Invoke(new()
    {
        Uuid = "apipolicy-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.GetApipolicyArgs;
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 fooApipolicy = AviFunctions.getApipolicy(GetApipolicyArgs.builder()
            .uuid("apipolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .name("foo")
            .build());

    }
}

variables:
  fooApipolicy:
    fn::invoke:
      function: avi:getApipolicy
      arguments:
        uuid: apipolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b
        name: foo

Example coming soon!

Using getApipolicy

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 getApipolicy(args: GetApipolicyArgs, opts?: InvokeOptions): Promise<GetApipolicyResult>
function getApipolicyOutput(args: GetApipolicyOutputArgs, opts?: InvokeOutputOptions): Output<GetApipolicyResult>

def get_apipolicy(id: Optional[str] = None,
                  name: Optional[str] = None,
                  tenant_ref: Optional[str] = None,
                  uuid: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetApipolicyResult
def get_apipolicy_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[GetApipolicyResult]

func LookupApipolicy(ctx *Context, args *LookupApipolicyArgs, opts ...InvokeOption) (*LookupApipolicyResult, error)
func LookupApipolicyOutput(ctx *Context, args *LookupApipolicyOutputArgs, opts ...InvokeOption) LookupApipolicyResultOutput

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

public static class GetApipolicy 
{
    public static Task<GetApipolicyResult> InvokeAsync(GetApipolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetApipolicyResult> Invoke(GetApipolicyInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetApipolicyResult> Invoke(GetApipolicyInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetApipolicyResult> getApipolicy(GetApipolicyArgs args, InvokeOptions options)
public static Output<GetApipolicyResult> getApipolicy(GetApipolicyArgs args, InvokeOptions options)
public static Output<GetApipolicyResult> getApipolicy(GetApipolicyArgs args, InvokeOutputOptions options)

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

data "avi_get_apipolicy" "name" {
    # arguments
}

The following arguments are supported:

Id string
Name string: Search ApiPolicy 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 ApiPolicy by uuid.

Id string
Name string: Search ApiPolicy 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 ApiPolicy by uuid.

id string
name string: Search ApiPolicy 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 ApiPolicy by uuid.

id String
name String: Search ApiPolicy 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 ApiPolicy by uuid.

id string
name string: Search ApiPolicy 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 ApiPolicy by uuid.

id str
name str: Search ApiPolicy 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 ApiPolicy by uuid.

id String
name String: Search ApiPolicy 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 ApiPolicy by uuid.

getApipolicy Result

The following output properties are available:

ActiveApiLabels List<GetApipolicyActiveApiLabel>: List of labels applied to active api endpoints. An active api is an endpoint whose type is api_active. Endpoints defined in the policy are active by default. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ApiSpecInfos List<GetApipolicyApiSpecInfo>: Api specification metadata extracted from the associated openapi specification. Automatically populated when a fileobject is associated with this policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes List<GetApipolicyConfigpbAttribute>: 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 policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
FileObjectRefs List<string>: Reference to the uploaded openapi specification file associated with this policy. Only one file is supported at a time. It is a reference to an object of type fileobject. Field introduced in 32.1.4. Maximum of 1 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
LabelMappings List<GetApipolicyLabelMapping>: Mapping of labels to api policy actions. Field introduced in 32.1.4. Maximum of 256 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.
NonApiUrlLabels List<GetApipolicyNonApiUrlLabel>: List of labels applied to non-api url requests. Non-api urls are methods and urls that are outside the scope of the policy. These are usually used to retrieve static information that are not tied to back-end business logic. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
OrphanApiClassificationSettings List<GetApipolicyOrphanApiClassificationSetting>: Orphan api classification settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
OrphanApiLabels List<GetApipolicyOrphanApiLabel>: List of labels applied to orphan api endpoints. An orphan api is an endpoint that is specified in the api-spec but has not been seen in the datapath for a predefined duration. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
PathRefs List<string>: List of path specifications. When an oas fileobject is associated to this apipolicy, the paths defined in the oas fileobject will be automatically added to this list. If oas fileobject has a path that is already defined in the list, the existing path in the list will be updated as per the oas fileobject. It is a reference to an object of type apipath. Field introduced in 32.1.4. Maximum of 2000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
RoutingInfos List<GetApipolicyRoutingInfo>: Optional header-based routing configuration for evh child vs selection. When set, the rules inside are used in addition to server fqdns (host match) and server_info.path_prefix (path match) to determine which child vs handles a request. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ServerInfos List<GetApipolicyServerInfo>: Server list defining the scope of this api policy. Requests not matching any server url are treated as non-api traffic. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ShadowApiLabels List<GetApipolicyShadowApiLabel>: List of labels applied to shadow api endpoints. A shadow api is an endpoint that is not specified in the api-spec but is inside the scope of this policy (matching the server url and path prefix) and is seen in the datapath. 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.
Uuid string: The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ValidationSettings List<GetApipolicyValidationSetting>: Validation settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ZombieApiClassificationSettings List<GetApipolicyZombieApiClassificationSetting>: Zombie api classification settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ZombieApiLabels List<GetApipolicyZombieApiLabel>: List of labels applied to zombie api endpoints. A zombie api is an endpoint that is specified in the api-spec but is seen in the datapath only as drip-traffic over a predefined duration. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

ActiveApiLabels []GetApipolicyActiveApiLabel: List of labels applied to active api endpoints. An active api is an endpoint whose type is api_active. Endpoints defined in the policy are active by default. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ApiSpecInfos []GetApipolicyApiSpecInfo: Api specification metadata extracted from the associated openapi specification. Automatically populated when a fileobject is associated with this policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []GetApipolicyConfigpbAttribute: 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 policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
FileObjectRefs []string: Reference to the uploaded openapi specification file associated with this policy. Only one file is supported at a time. It is a reference to an object of type fileobject. Field introduced in 32.1.4. Maximum of 1 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
LabelMappings []GetApipolicyLabelMapping: Mapping of labels to api policy actions. Field introduced in 32.1.4. Maximum of 256 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.
NonApiUrlLabels []GetApipolicyNonApiUrlLabel: List of labels applied to non-api url requests. Non-api urls are methods and urls that are outside the scope of the policy. These are usually used to retrieve static information that are not tied to back-end business logic. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
OrphanApiClassificationSettings []GetApipolicyOrphanApiClassificationSetting: Orphan api classification settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
OrphanApiLabels []GetApipolicyOrphanApiLabel: List of labels applied to orphan api endpoints. An orphan api is an endpoint that is specified in the api-spec but has not been seen in the datapath for a predefined duration. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
PathRefs []string: List of path specifications. When an oas fileobject is associated to this apipolicy, the paths defined in the oas fileobject will be automatically added to this list. If oas fileobject has a path that is already defined in the list, the existing path in the list will be updated as per the oas fileobject. It is a reference to an object of type apipath. Field introduced in 32.1.4. Maximum of 2000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
RoutingInfos []GetApipolicyRoutingInfo: Optional header-based routing configuration for evh child vs selection. When set, the rules inside are used in addition to server fqdns (host match) and server_info.path_prefix (path match) to determine which child vs handles a request. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ServerInfos []GetApipolicyServerInfo: Server list defining the scope of this api policy. Requests not matching any server url are treated as non-api traffic. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ShadowApiLabels []GetApipolicyShadowApiLabel: List of labels applied to shadow api endpoints. A shadow api is an endpoint that is not specified in the api-spec but is inside the scope of this policy (matching the server url and path prefix) and is seen in the datapath. 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.
Uuid string: The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ValidationSettings []GetApipolicyValidationSetting: Validation settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ZombieApiClassificationSettings []GetApipolicyZombieApiClassificationSetting: Zombie api classification settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ZombieApiLabels []GetApipolicyZombieApiLabel: List of labels applied to zombie api endpoints. A zombie api is an endpoint that is specified in the api-spec but is seen in the datapath only as drip-traffic over a predefined duration. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

active_api_labels list(object): List of labels applied to active api endpoints. An active api is an endpoint whose type is api_active. Endpoints defined in the policy are active by default. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
api_spec_infos list(object): Api specification metadata extracted from the associated openapi specification. Automatically populated when a fileobject is associated with this policy. 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 policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
file_object_refs list(string): Reference to the uploaded openapi specification file associated with this policy. Only one file is supported at a time. It is a reference to an object of type fileobject. Field introduced in 32.1.4. Maximum of 1 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id string
label_mappings list(object): Mapping of labels to api policy actions. Field introduced in 32.1.4. Maximum of 256 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.
non_api_url_labels list(object): List of labels applied to non-api url requests. Non-api urls are methods and urls that are outside the scope of the policy. These are usually used to retrieve static information that are not tied to back-end business logic. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
orphan_api_classification_settings list(object): Orphan api classification settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
orphan_api_labels list(object): List of labels applied to orphan api endpoints. An orphan api is an endpoint that is specified in the api-spec but has not been seen in the datapath for a predefined duration. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
path_refs list(string): List of path specifications. When an oas fileobject is associated to this apipolicy, the paths defined in the oas fileobject will be automatically added to this list. If oas fileobject has a path that is already defined in the list, the existing path in the list will be updated as per the oas fileobject. It is a reference to an object of type apipath. Field introduced in 32.1.4. Maximum of 2000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
routing_infos list(object): Optional header-based routing configuration for evh child vs selection. When set, the rules inside are used in addition to server fqdns (host match) and server_info.path_prefix (path match) to determine which child vs handles a request. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
server_infos list(object): Server list defining the scope of this api policy. Requests not matching any server url are treated as non-api traffic. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
shadow_api_labels list(object): List of labels applied to shadow api endpoints. A shadow api is an endpoint that is not specified in the api-spec but is inside the scope of this policy (matching the server url and path prefix) and is seen in the datapath. 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.
uuid string: The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
validation_settings list(object): Validation settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
zombie_api_classification_settings list(object): Zombie api classification settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
zombie_api_labels list(object): List of labels applied to zombie api endpoints. A zombie api is an endpoint that is specified in the api-spec but is seen in the datapath only as drip-traffic over a predefined duration. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

activeApiLabels List<GetApipolicyActiveApiLabel>: List of labels applied to active api endpoints. An active api is an endpoint whose type is api_active. Endpoints defined in the policy are active by default. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
apiSpecInfos List<GetApipolicyApiSpecInfo>: Api specification metadata extracted from the associated openapi specification. Automatically populated when a fileobject is associated with this policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<GetApipolicyConfigpbAttribute>: 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 policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
fileObjectRefs List<String>: Reference to the uploaded openapi specification file associated with this policy. Only one file is supported at a time. It is a reference to an object of type fileobject. Field introduced in 32.1.4. Maximum of 1 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
labelMappings List<GetApipolicyLabelMapping>: Mapping of labels to api policy actions. Field introduced in 32.1.4. Maximum of 256 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.
nonApiUrlLabels List<GetApipolicyNonApiUrlLabel>: List of labels applied to non-api url requests. Non-api urls are methods and urls that are outside the scope of the policy. These are usually used to retrieve static information that are not tied to back-end business logic. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
orphanApiClassificationSettings List<GetApipolicyOrphanApiClassificationSetting>: Orphan api classification settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
orphanApiLabels List<GetApipolicyOrphanApiLabel>: List of labels applied to orphan api endpoints. An orphan api is an endpoint that is specified in the api-spec but has not been seen in the datapath for a predefined duration. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
pathRefs List<String>: List of path specifications. When an oas fileobject is associated to this apipolicy, the paths defined in the oas fileobject will be automatically added to this list. If oas fileobject has a path that is already defined in the list, the existing path in the list will be updated as per the oas fileobject. It is a reference to an object of type apipath. Field introduced in 32.1.4. Maximum of 2000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
routingInfos List<GetApipolicyRoutingInfo>: Optional header-based routing configuration for evh child vs selection. When set, the rules inside are used in addition to server fqdns (host match) and server_info.path_prefix (path match) to determine which child vs handles a request. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
serverInfos List<GetApipolicyServerInfo>: Server list defining the scope of this api policy. Requests not matching any server url are treated as non-api traffic. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
shadowApiLabels List<GetApipolicyShadowApiLabel>: List of labels applied to shadow api endpoints. A shadow api is an endpoint that is not specified in the api-spec but is inside the scope of this policy (matching the server url and path prefix) and is seen in the datapath. 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.
uuid String: The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
validationSettings List<GetApipolicyValidationSetting>: Validation settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
zombieApiClassificationSettings List<GetApipolicyZombieApiClassificationSetting>: Zombie api classification settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
zombieApiLabels List<GetApipolicyZombieApiLabel>: List of labels applied to zombie api endpoints. A zombie api is an endpoint that is specified in the api-spec but is seen in the datapath only as drip-traffic over a predefined duration. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

activeApiLabels GetApipolicyActiveApiLabel[]: List of labels applied to active api endpoints. An active api is an endpoint whose type is api_active. Endpoints defined in the policy are active by default. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
apiSpecInfos GetApipolicyApiSpecInfo[]: Api specification metadata extracted from the associated openapi specification. Automatically populated when a fileobject is associated with this policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes GetApipolicyConfigpbAttribute[]: 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 policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
fileObjectRefs string[]: Reference to the uploaded openapi specification file associated with this policy. Only one file is supported at a time. It is a reference to an object of type fileobject. Field introduced in 32.1.4. Maximum of 1 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id string
labelMappings GetApipolicyLabelMapping[]: Mapping of labels to api policy actions. Field introduced in 32.1.4. Maximum of 256 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.
nonApiUrlLabels GetApipolicyNonApiUrlLabel[]: List of labels applied to non-api url requests. Non-api urls are methods and urls that are outside the scope of the policy. These are usually used to retrieve static information that are not tied to back-end business logic. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
orphanApiClassificationSettings GetApipolicyOrphanApiClassificationSetting[]: Orphan api classification settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
orphanApiLabels GetApipolicyOrphanApiLabel[]: List of labels applied to orphan api endpoints. An orphan api is an endpoint that is specified in the api-spec but has not been seen in the datapath for a predefined duration. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
pathRefs string[]: List of path specifications. When an oas fileobject is associated to this apipolicy, the paths defined in the oas fileobject will be automatically added to this list. If oas fileobject has a path that is already defined in the list, the existing path in the list will be updated as per the oas fileobject. It is a reference to an object of type apipath. Field introduced in 32.1.4. Maximum of 2000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
routingInfos GetApipolicyRoutingInfo[]: Optional header-based routing configuration for evh child vs selection. When set, the rules inside are used in addition to server fqdns (host match) and server_info.path_prefix (path match) to determine which child vs handles a request. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
serverInfos GetApipolicyServerInfo[]: Server list defining the scope of this api policy. Requests not matching any server url are treated as non-api traffic. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
shadowApiLabels GetApipolicyShadowApiLabel[]: List of labels applied to shadow api endpoints. A shadow api is an endpoint that is not specified in the api-spec but is inside the scope of this policy (matching the server url and path prefix) and is seen in the datapath. 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.
uuid string: The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
validationSettings GetApipolicyValidationSetting[]: Validation settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
zombieApiClassificationSettings GetApipolicyZombieApiClassificationSetting[]: Zombie api classification settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
zombieApiLabels GetApipolicyZombieApiLabel[]: List of labels applied to zombie api endpoints. A zombie api is an endpoint that is specified in the api-spec but is seen in the datapath only as drip-traffic over a predefined duration. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

active_api_labels Sequence[GetApipolicyActiveApiLabel]: List of labels applied to active api endpoints. An active api is an endpoint whose type is api_active. Endpoints defined in the policy are active by default. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
api_spec_infos Sequence[GetApipolicyApiSpecInfo]: Api specification metadata extracted from the associated openapi specification. Automatically populated when a fileobject is associated with this policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[GetApipolicyConfigpbAttribute]: 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 policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
file_object_refs Sequence[str]: Reference to the uploaded openapi specification file associated with this policy. Only one file is supported at a time. It is a reference to an object of type fileobject. Field introduced in 32.1.4. Maximum of 1 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id str
label_mappings Sequence[GetApipolicyLabelMapping]: Mapping of labels to api policy actions. Field introduced in 32.1.4. Maximum of 256 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.
non_api_url_labels Sequence[GetApipolicyNonApiUrlLabel]: List of labels applied to non-api url requests. Non-api urls are methods and urls that are outside the scope of the policy. These are usually used to retrieve static information that are not tied to back-end business logic. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
orphan_api_classification_settings Sequence[GetApipolicyOrphanApiClassificationSetting]: Orphan api classification settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
orphan_api_labels Sequence[GetApipolicyOrphanApiLabel]: List of labels applied to orphan api endpoints. An orphan api is an endpoint that is specified in the api-spec but has not been seen in the datapath for a predefined duration. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
path_refs Sequence[str]: List of path specifications. When an oas fileobject is associated to this apipolicy, the paths defined in the oas fileobject will be automatically added to this list. If oas fileobject has a path that is already defined in the list, the existing path in the list will be updated as per the oas fileobject. It is a reference to an object of type apipath. Field introduced in 32.1.4. Maximum of 2000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
routing_infos Sequence[GetApipolicyRoutingInfo]: Optional header-based routing configuration for evh child vs selection. When set, the rules inside are used in addition to server fqdns (host match) and server_info.path_prefix (path match) to determine which child vs handles a request. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
server_infos Sequence[GetApipolicyServerInfo]: Server list defining the scope of this api policy. Requests not matching any server url are treated as non-api traffic. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
shadow_api_labels Sequence[GetApipolicyShadowApiLabel]: List of labels applied to shadow api endpoints. A shadow api is an endpoint that is not specified in the api-spec but is inside the scope of this policy (matching the server url and path prefix) and is seen in the datapath. 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.
uuid str: The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
validation_settings Sequence[GetApipolicyValidationSetting]: Validation settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
zombie_api_classification_settings Sequence[GetApipolicyZombieApiClassificationSetting]: Zombie api classification settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
zombie_api_labels Sequence[GetApipolicyZombieApiLabel]: List of labels applied to zombie api endpoints. A zombie api is an endpoint that is specified in the api-spec but is seen in the datapath only as drip-traffic over a predefined duration. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

activeApiLabels List<Property Map>: List of labels applied to active api endpoints. An active api is an endpoint whose type is api_active. Endpoints defined in the policy are active by default. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
apiSpecInfos List<Property Map>: Api specification metadata extracted from the associated openapi specification. Automatically populated when a fileobject is associated with this policy. 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 policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
fileObjectRefs List<String>: Reference to the uploaded openapi specification file associated with this policy. Only one file is supported at a time. It is a reference to an object of type fileobject. Field introduced in 32.1.4. Maximum of 1 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
labelMappings List<Property Map>: Mapping of labels to api policy actions. Field introduced in 32.1.4. Maximum of 256 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.
nonApiUrlLabels List<Property Map>: List of labels applied to non-api url requests. Non-api urls are methods and urls that are outside the scope of the policy. These are usually used to retrieve static information that are not tied to back-end business logic. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
orphanApiClassificationSettings List<Property Map>: Orphan api classification settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
orphanApiLabels List<Property Map>: List of labels applied to orphan api endpoints. An orphan api is an endpoint that is specified in the api-spec but has not been seen in the datapath for a predefined duration. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
pathRefs List<String>: List of path specifications. When an oas fileobject is associated to this apipolicy, the paths defined in the oas fileobject will be automatically added to this list. If oas fileobject has a path that is already defined in the list, the existing path in the list will be updated as per the oas fileobject. It is a reference to an object of type apipath. Field introduced in 32.1.4. Maximum of 2000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
routingInfos List<Property Map>: Optional header-based routing configuration for evh child vs selection. When set, the rules inside are used in addition to server fqdns (host match) and server_info.path_prefix (path match) to determine which child vs handles a request. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
serverInfos List<Property Map>: Server list defining the scope of this api policy. Requests not matching any server url are treated as non-api traffic. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
shadowApiLabels List<Property Map>: List of labels applied to shadow api endpoints. A shadow api is an endpoint that is not specified in the api-spec but is inside the scope of this policy (matching the server url and path prefix) and is seen in the datapath. 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.
uuid String: The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
validationSettings List<Property Map>: Validation settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
zombieApiClassificationSettings List<Property Map>: Zombie api classification settings for this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
zombieApiLabels List<Property Map>: List of labels applied to zombie api endpoints. A zombie api is an endpoint that is specified in the api-spec but is seen in the datapath only as drip-traffic over a predefined duration. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Supporting Types

GetApipolicyActiveApiLabel

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>

GetApipolicyApiSpecInfo

ComponentSchemaCount string
Description string: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
InlineSchemaCount string
OasVersion string
PathCount string
Servers List<GetApipolicyApiSpecInfoServer>
Title string
Version string

ComponentSchemaCount string
Description string: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
InlineSchemaCount string
OasVersion string
PathCount string
Servers []GetApipolicyApiSpecInfoServer
Title string
Version string

component_schema_count string
description string: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
inline_schema_count string
oas_version string
path_count string
servers list(object)
title string
version string

componentSchemaCount String
description String: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
inlineSchemaCount String
oasVersion String
pathCount String
servers List<GetApipolicyApiSpecInfoServer>
title String
version String

componentSchemaCount string
description string: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
inlineSchemaCount string
oasVersion string
pathCount string
servers GetApipolicyApiSpecInfoServer[]
title string
version string

component_schema_count str
description str: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
inline_schema_count str
oas_version str
path_count str
servers Sequence[GetApipolicyApiSpecInfoServer]
title str
version str

componentSchemaCount String
description String: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
inlineSchemaCount String
oasVersion String
pathCount String
servers List<Property Map>
title String
version String

GetApipolicyApiSpecInfoServer

Description string: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Url string

Description string: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Url string

description string: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
url string

description String: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
url String

description string: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
url string

description str: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
url str

description String: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
url String

GetApipolicyConfigpbAttribute

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

GetApipolicyLabelMapping

ApiPolicyActions List<string>
Enabled string
Label string

ApiPolicyActions []string
Enabled string
Label string

api_policy_actions list(string)
enabled string
label string

apiPolicyActions List<String>
enabled String
label String

apiPolicyActions string[]
enabled string
label string

api_policy_actions Sequence[str]
enabled str
label str

apiPolicyActions List<String>
enabled String
label String

GetApipolicyNonApiUrlLabel

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>

GetApipolicyOrphanApiClassificationSetting

Enabled string
InspectionIntervalUnit string
InspectionIntervalValue string

Enabled string
InspectionIntervalUnit string
InspectionIntervalValue string

enabled string
inspection_interval_unit string
inspection_interval_value string

enabled String
inspectionIntervalUnit String
inspectionIntervalValue String

enabled string
inspectionIntervalUnit string
inspectionIntervalValue string

enabled str
inspection_interval_unit str
inspection_interval_value str

enabled String
inspectionIntervalUnit String
inspectionIntervalValue String

GetApipolicyOrphanApiLabel

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>

GetApipolicyRoutingInfo

Rules List<GetApipolicyRoutingInfoRule>

Rules []GetApipolicyRoutingInfoRule

rules list(object)

rules List<GetApipolicyRoutingInfoRule>

rules GetApipolicyRoutingInfoRule[]

rules Sequence[GetApipolicyRoutingInfoRule]

rules List<Property Map>

GetApipolicyRoutingInfoRule

Matches List<GetApipolicyRoutingInfoRuleMatch>
Name string: Search ApiPolicy by name.

Matches []GetApipolicyRoutingInfoRuleMatch
Name string: Search ApiPolicy by name.

matches list(object)
name string: Search ApiPolicy by name.

matches List<GetApipolicyRoutingInfoRuleMatch>
name String: Search ApiPolicy by name.

matches GetApipolicyRoutingInfoRuleMatch[]
name string: Search ApiPolicy by name.

matches Sequence[GetApipolicyRoutingInfoRuleMatch]
name str: Search ApiPolicy by name.

matches List<Property Map>
name String: Search ApiPolicy by name.

GetApipolicyRoutingInfoRuleMatchClientIpAddr

Addr string
Type string

Addr string
Type string

addr string
type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

GetApipolicyRoutingInfoRuleMatchClientIpPrefix

IpAddrs List<GetApipolicyRoutingInfoRuleMatchClientIpPrefixIpAddr>
Mask string

IpAddrs []GetApipolicyRoutingInfoRuleMatchClientIpPrefixIpAddr
Mask string

ip_addrs list(object)
mask string

ipAddrs List<GetApipolicyRoutingInfoRuleMatchClientIpPrefixIpAddr>
mask String

ipAddrs GetApipolicyRoutingInfoRuleMatchClientIpPrefixIpAddr[]
mask string

ip_addrs Sequence[GetApipolicyRoutingInfoRuleMatchClientIpPrefixIpAddr]
mask str

ipAddrs List<Property Map>
mask String

GetApipolicyRoutingInfoRuleMatchClientIpPrefixIpAddr

Addr string
Type string

Addr string
Type string

addr string
type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

GetApipolicyRoutingInfoRuleMatchClientIpRange

Begins List<GetApipolicyRoutingInfoRuleMatchClientIpRangeBegin>
Ends List<GetApipolicyRoutingInfoRuleMatchClientIpRangeEnd>

Begins []GetApipolicyRoutingInfoRuleMatchClientIpRangeBegin
Ends []GetApipolicyRoutingInfoRuleMatchClientIpRangeEnd

begins list(object)
ends list(object)

begins List<GetApipolicyRoutingInfoRuleMatchClientIpRangeBegin>
ends List<GetApipolicyRoutingInfoRuleMatchClientIpRangeEnd>

begins GetApipolicyRoutingInfoRuleMatchClientIpRangeBegin[]
ends GetApipolicyRoutingInfoRuleMatchClientIpRangeEnd[]

begins Sequence[GetApipolicyRoutingInfoRuleMatchClientIpRangeBegin]
ends Sequence[GetApipolicyRoutingInfoRuleMatchClientIpRangeEnd]

begins List<Property Map>
ends List<Property Map>

GetApipolicyRoutingInfoRuleMatchClientIpRangeBegin

Addr string
Type string

Addr string
Type string

addr string
type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

GetApipolicyRoutingInfoRuleMatchClientIpRangeEnd

Addr string
Type string

Addr string
Type string

addr string
type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

GetApipolicyRoutingInfoRuleMatchCookie

MatchCase string
MatchCriteria string
Name string: Search ApiPolicy by name.
Value string

MatchCase string
MatchCriteria string
Name string: Search ApiPolicy by name.
Value string

match_case string
match_criteria string
name string: Search ApiPolicy by name.
value string

matchCase String
matchCriteria String
name String: Search ApiPolicy by name.
value String

matchCase string
matchCriteria string
name string: Search ApiPolicy by name.
value string

match_case str
match_criteria str
name str: Search ApiPolicy by name.
value str

matchCase String
matchCriteria String
name String: Search ApiPolicy by name.
value String

GetApipolicyRoutingInfoRuleMatchGeoMatch

Attribute string
MatchOperation string
Values List<string>

Attribute string
MatchOperation string
Values []string

attribute string
match_operation string
values list(string)

attribute String
matchOperation String
values List<String>

attribute string
matchOperation string
values string[]

attribute str
match_operation str
values Sequence[str]

attribute String
matchOperation String
values List<String>

GetApipolicyRoutingInfoRuleMatchHdr

Hdr string
MatchCase string
MatchCriteria string
StringGroupRefs List<string>
Values List<string>

Hdr string
MatchCase string
MatchCriteria string
StringGroupRefs []string
Values []string

hdr string
match_case string
match_criteria string
string_group_refs list(string)
values list(string)

hdr String
matchCase String
matchCriteria String
stringGroupRefs List<String>
values List<String>

hdr string
matchCase string
matchCriteria string
stringGroupRefs string[]
values string[]

hdr str
match_case str
match_criteria str
string_group_refs Sequence[str]
values Sequence[str]

hdr String
matchCase String
matchCriteria String
stringGroupRefs List<String>
values List<String>

GetApipolicyRoutingInfoRuleMatchHostHdr

MatchCase string
MatchCriteria string
Values List<string>

MatchCase string
MatchCriteria string
Values []string

match_case string
match_criteria string
values list(string)

matchCase String
matchCriteria String
values List<String>

matchCase string
matchCriteria string
values string[]

match_case str
match_criteria str
values Sequence[str]

matchCase String
matchCriteria String
values List<String>

GetApipolicyRoutingInfoRuleMatchIpReputationType

MatchOperation string
ReputationTypes List<string>

MatchOperation string
ReputationTypes []string

match_operation string
reputation_types list(string)

matchOperation String
reputationTypes List<String>

matchOperation string
reputationTypes string[]

match_operation str
reputation_types Sequence[str]

matchOperation String
reputationTypes List<String>

GetApipolicyRoutingInfoRuleMatchLabel

MatchCriteria string
Values List<string>

MatchCriteria string
Values []string

match_criteria string
values list(string)

matchCriteria String
values List<String>

matchCriteria string
values string[]

match_criteria str
values Sequence[str]

matchCriteria String
values List<String>

GetApipolicyRoutingInfoRuleMatchMethod

MatchCriteria string
Methods List<string>

MatchCriteria string
Methods []string

match_criteria string
methods list(string)

matchCriteria String
methods List<String>

matchCriteria string
methods string[]

match_criteria str
methods Sequence[str]

matchCriteria String
methods List<String>

GetApipolicyRoutingInfoRuleMatchPath

MatchCase string
MatchCriteria string
MatchDecodedString string
MatchStrs List<string>
StringGroupRefs List<string>

MatchCase string
MatchCriteria string
MatchDecodedString string
MatchStrs []string
StringGroupRefs []string

match_case string
match_criteria string
match_decoded_string string
match_strs list(string)
string_group_refs list(string)

matchCase String
matchCriteria String
matchDecodedString String
matchStrs List<String>
stringGroupRefs List<String>

matchCase string
matchCriteria string
matchDecodedString string
matchStrs string[]
stringGroupRefs string[]

match_case str
match_criteria str
match_decoded_string str
match_strs Sequence[str]
string_group_refs Sequence[str]

matchCase String
matchCriteria String
matchDecodedString String
matchStrs List<String>
stringGroupRefs List<String>

GetApipolicyRoutingInfoRuleMatchProtocol

MatchCriteria string
Protocols string

MatchCriteria string
Protocols string

match_criteria string
protocols string

matchCriteria String
protocols String

matchCriteria string
protocols string

match_criteria str
protocols str

matchCriteria String
protocols String

GetApipolicyRoutingInfoRuleMatchQuery

MatchCase string
MatchCriteria string
MatchDecodedString string
MatchStrs List<string>
StringGroupRefs List<string>

MatchCase string
MatchCriteria string
MatchDecodedString string
MatchStrs []string
StringGroupRefs []string

match_case string
match_criteria string
match_decoded_string string
match_strs list(string)
string_group_refs list(string)

matchCase String
matchCriteria String
matchDecodedString String
matchStrs List<String>
stringGroupRefs List<String>

matchCase string
matchCriteria string
matchDecodedString string
matchStrs string[]
stringGroupRefs string[]

match_case str
match_criteria str
match_decoded_string str
match_strs Sequence[str]
string_group_refs Sequence[str]

matchCase String
matchCriteria String
matchDecodedString String
matchStrs List<String>
stringGroupRefs List<String>

GetApipolicyRoutingInfoRuleMatchSourceIp

Addrs List<GetApipolicyRoutingInfoRuleMatchSourceIpAddr>
GroupRefs List<string>
MatchCriteria string
Prefixes List<GetApipolicyRoutingInfoRuleMatchSourceIpPrefix>
Ranges List<GetApipolicyRoutingInfoRuleMatchSourceIpRange>

Addrs []GetApipolicyRoutingInfoRuleMatchSourceIpAddr
GroupRefs []string
MatchCriteria string
Prefixes []GetApipolicyRoutingInfoRuleMatchSourceIpPrefix
Ranges []GetApipolicyRoutingInfoRuleMatchSourceIpRange

addrs list(object)
group_refs list(string)
match_criteria string
prefixes list(object)
ranges list(object)

addrs List<GetApipolicyRoutingInfoRuleMatchSourceIpAddr>
groupRefs List<String>
matchCriteria String
prefixes List<GetApipolicyRoutingInfoRuleMatchSourceIpPrefix>
ranges List<GetApipolicyRoutingInfoRuleMatchSourceIpRange>

addrs GetApipolicyRoutingInfoRuleMatchSourceIpAddr[]
groupRefs string[]
matchCriteria string
prefixes GetApipolicyRoutingInfoRuleMatchSourceIpPrefix[]
ranges GetApipolicyRoutingInfoRuleMatchSourceIpRange[]

addrs Sequence[GetApipolicyRoutingInfoRuleMatchSourceIpAddr]
group_refs Sequence[str]
match_criteria str
prefixes Sequence[GetApipolicyRoutingInfoRuleMatchSourceIpPrefix]
ranges Sequence[GetApipolicyRoutingInfoRuleMatchSourceIpRange]

addrs List<Property Map>
groupRefs List<String>
matchCriteria String
prefixes List<Property Map>
ranges List<Property Map>

GetApipolicyRoutingInfoRuleMatchSourceIpAddr

Addr string
Type string

Addr string
Type string

addr string
type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

GetApipolicyRoutingInfoRuleMatchSourceIpPrefix

IpAddrs List<GetApipolicyRoutingInfoRuleMatchSourceIpPrefixIpAddr>
Mask string

IpAddrs []GetApipolicyRoutingInfoRuleMatchSourceIpPrefixIpAddr
Mask string

ip_addrs list(object)
mask string

ipAddrs List<GetApipolicyRoutingInfoRuleMatchSourceIpPrefixIpAddr>
mask String

ipAddrs GetApipolicyRoutingInfoRuleMatchSourceIpPrefixIpAddr[]
mask string

ip_addrs Sequence[GetApipolicyRoutingInfoRuleMatchSourceIpPrefixIpAddr]
mask str

ipAddrs List<Property Map>
mask String

GetApipolicyRoutingInfoRuleMatchSourceIpPrefixIpAddr

Addr string
Type string

Addr string
Type string

addr string
type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

GetApipolicyRoutingInfoRuleMatchSourceIpRange

Begins List<GetApipolicyRoutingInfoRuleMatchSourceIpRangeBegin>
Ends List<GetApipolicyRoutingInfoRuleMatchSourceIpRangeEnd>

Begins []GetApipolicyRoutingInfoRuleMatchSourceIpRangeBegin
Ends []GetApipolicyRoutingInfoRuleMatchSourceIpRangeEnd

begins list(object)
ends list(object)

begins List<GetApipolicyRoutingInfoRuleMatchSourceIpRangeBegin>
ends List<GetApipolicyRoutingInfoRuleMatchSourceIpRangeEnd>

begins GetApipolicyRoutingInfoRuleMatchSourceIpRangeBegin[]
ends GetApipolicyRoutingInfoRuleMatchSourceIpRangeEnd[]

begins Sequence[GetApipolicyRoutingInfoRuleMatchSourceIpRangeBegin]
ends Sequence[GetApipolicyRoutingInfoRuleMatchSourceIpRangeEnd]

begins List<Property Map>
ends List<Property Map>

GetApipolicyRoutingInfoRuleMatchSourceIpRangeBegin

Addr string
Type string

Addr string
Type string

addr string
type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

GetApipolicyRoutingInfoRuleMatchSourceIpRangeEnd

Addr string
Type string

Addr string
Type string

addr string
type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

GetApipolicyRoutingInfoRuleMatchTlsFingerprintMatch

Fingerprints List<string>
MatchOperation string
StringGroupRefs List<string>

Fingerprints []string
MatchOperation string
StringGroupRefs []string

fingerprints list(string)
match_operation string
string_group_refs list(string)

fingerprints List<String>
matchOperation String
stringGroupRefs List<String>

fingerprints string[]
matchOperation string
stringGroupRefs string[]

fingerprints Sequence[str]
match_operation str
string_group_refs Sequence[str]

fingerprints List<String>
matchOperation String
stringGroupRefs List<String>

GetApipolicyRoutingInfoRuleMatchVersion

MatchCriteria string
Versions List<string>

MatchCriteria string
Versions []string

match_criteria string
versions list(string)

matchCriteria String
versions List<String>

matchCriteria string
versions string[]

match_criteria str
versions Sequence[str]

matchCriteria String
versions List<String>

GetApipolicyRoutingInfoRuleMatchVsPort

MatchCriteria string
Ports List<double>

MatchCriteria string
Ports []float64

match_criteria string
ports list(number)

matchCriteria String
ports List<Double>

matchCriteria string
ports number[]

match_criteria str
ports Sequence[float]

matchCriteria String
ports List<Number>

GetApipolicyServerInfo

PathPrefix string
Servers List<GetApipolicyServerInfoServer>

PathPrefix string
Servers []GetApipolicyServerInfoServer

path_prefix string
servers list(object)

pathPrefix String
servers List<GetApipolicyServerInfoServer>

pathPrefix string
servers GetApipolicyServerInfoServer[]

path_prefix str
servers Sequence[GetApipolicyServerInfoServer]

pathPrefix String
servers List<Property Map>

GetApipolicyServerInfoServer

Description string: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Url string

Description string: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Url string

description string: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
url string

description String: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
url String

description string: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
url string

description str: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
url str

description String: Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
url String