published on Friday, Oct 23, 2026 by vmware
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-resource-apipolicy”
description: |-
Creates and manages Avi ApiPolicy.
avi.Apipolicy
The ApiPolicy resource allows the creation and management of Avi ApiPolicy
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as avi from "@pulumi/avi";
const foo = new avi.Apipolicy("foo", {
name: "terraform-example-foo",
tenantRef: "/api/tenant/?name=admin",
});
import pulumi
import pulumi_avi as avi
foo = avi.Apipolicy("foo",
name="terraform-example-foo",
tenant_ref="/api/tenant/?name=admin")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v32/avi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := avi.NewApipolicy(ctx, "foo", &avi.ApipolicyArgs{
Name: pulumi.String("terraform-example-foo"),
TenantRef: pulumi.String("/api/tenant/?name=admin"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;
return await Deployment.RunAsync(() =>
{
var foo = new Avi.Apipolicy("foo", new()
{
Name = "terraform-example-foo",
TenantRef = "/api/tenant/?name=admin",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Apipolicy;
import com.pulumi.avi.ApipolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var foo = new Apipolicy("foo", ApipolicyArgs.builder()
.name("terraform-example-foo")
.tenantRef("/api/tenant/?name=admin")
.build());
}
}
resources:
foo:
type: avi:Apipolicy
properties:
name: terraform-example-foo
tenantRef: /api/tenant/?name=admin
Example coming soon!
Create Apipolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Apipolicy(name: string, args?: ApipolicyArgs, opts?: CustomResourceOptions);@overload
def Apipolicy(resource_name: str,
args: Optional[ApipolicyArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Apipolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
active_api_labels: Optional[Sequence[ApipolicyActiveApiLabelArgs]] = None,
api_spec_infos: Optional[Sequence[ApipolicyApiSpecInfoArgs]] = None,
apipolicy_id: Optional[str] = None,
configpb_attributes: Optional[Sequence[ApipolicyConfigpbAttributeArgs]] = None,
description: Optional[str] = None,
file_object_refs: Optional[Sequence[str]] = None,
label_mappings: Optional[Sequence[ApipolicyLabelMappingArgs]] = None,
name: Optional[str] = None,
non_api_url_labels: Optional[Sequence[ApipolicyNonApiUrlLabelArgs]] = None,
orphan_api_classification_settings: Optional[Sequence[ApipolicyOrphanApiClassificationSettingArgs]] = None,
orphan_api_labels: Optional[Sequence[ApipolicyOrphanApiLabelArgs]] = None,
path_refs: Optional[Sequence[str]] = None,
routing_infos: Optional[Sequence[ApipolicyRoutingInfoArgs]] = None,
server_infos: Optional[Sequence[ApipolicyServerInfoArgs]] = None,
shadow_api_labels: Optional[Sequence[ApipolicyShadowApiLabelArgs]] = None,
tenant_ref: Optional[str] = None,
uuid: Optional[str] = None,
validation_settings: Optional[Sequence[ApipolicyValidationSettingArgs]] = None,
zombie_api_classification_settings: Optional[Sequence[ApipolicyZombieApiClassificationSettingArgs]] = None,
zombie_api_labels: Optional[Sequence[ApipolicyZombieApiLabelArgs]] = None)func NewApipolicy(ctx *Context, name string, args *ApipolicyArgs, opts ...ResourceOption) (*Apipolicy, error)public Apipolicy(string name, ApipolicyArgs? args = null, CustomResourceOptions? opts = null)
public Apipolicy(String name, ApipolicyArgs args)
public Apipolicy(String name, ApipolicyArgs args, CustomResourceOptions options)
type: avi:Apipolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "avi_apipolicy" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ApipolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ApipolicyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ApipolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApipolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApipolicyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var apipolicyResource = new Avi.Apipolicy("apipolicyResource", new()
{
ActiveApiLabels = new[]
{
new Avi.Inputs.ApipolicyActiveApiLabelArgs
{
Enabled = "string",
Labels = new[]
{
"string",
},
},
},
ApiSpecInfos = new[]
{
new Avi.Inputs.ApipolicyApiSpecInfoArgs
{
ComponentSchemaCount = "string",
Description = "string",
InlineSchemaCount = "string",
OasVersion = "string",
PathCount = "string",
Servers = new[]
{
new Avi.Inputs.ApipolicyApiSpecInfoServerArgs
{
Url = "string",
Description = "string",
},
},
Title = "string",
Version = "string",
},
},
ApipolicyId = "string",
ConfigpbAttributes = new[]
{
new Avi.Inputs.ApipolicyConfigpbAttributeArgs
{
CreatedBy = "string",
Version = "string",
},
},
Description = "string",
FileObjectRefs = new[]
{
"string",
},
LabelMappings = new[]
{
new Avi.Inputs.ApipolicyLabelMappingArgs
{
ApiPolicyActions = new[]
{
"string",
},
Label = "string",
Enabled = "string",
},
},
Name = "string",
NonApiUrlLabels = new[]
{
new Avi.Inputs.ApipolicyNonApiUrlLabelArgs
{
Enabled = "string",
Labels = new[]
{
"string",
},
},
},
OrphanApiClassificationSettings = new[]
{
new Avi.Inputs.ApipolicyOrphanApiClassificationSettingArgs
{
Enabled = "string",
InspectionIntervalUnit = "string",
InspectionIntervalValue = "string",
},
},
OrphanApiLabels = new[]
{
new Avi.Inputs.ApipolicyOrphanApiLabelArgs
{
Enabled = "string",
Labels = new[]
{
"string",
},
},
},
PathRefs = new[]
{
"string",
},
RoutingInfos = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoArgs
{
Rules = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleArgs
{
Matches = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchArgs
{
BotDetectionResults = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchBotDetectionResultArgs
{
MatchOperation = "string",
Classifications = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchBotDetectionResultClassificationArgs
{
Type = "string",
UserDefinedType = "string",
},
},
},
},
ClientIps = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchClientIpArgs
{
MatchCriteria = "string",
Addrs = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchClientIpAddrArgs
{
Addr = "string",
Type = "string",
},
},
GroupRefs = new[]
{
"string",
},
Prefixes = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchClientIpPrefixArgs
{
IpAddrs = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchClientIpPrefixIpAddrArgs
{
Addr = "string",
Type = "string",
},
},
Mask = "string",
},
},
Ranges = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchClientIpRangeArgs
{
Begins = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchClientIpRangeBeginArgs
{
Addr = "string",
Type = "string",
},
},
Ends = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchClientIpRangeEndArgs
{
Addr = "string",
Type = "string",
},
},
},
},
},
},
Cookies = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchCookieArgs
{
MatchCriteria = "string",
Name = "string",
MatchCase = "string",
Value = "string",
},
},
GeoMatches = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchGeoMatchArgs
{
Attribute = "string",
MatchOperation = "string",
Values = new[]
{
"string",
},
},
},
Hdrs = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchHdrArgs
{
Hdr = "string",
MatchCriteria = "string",
MatchCase = "string",
StringGroupRefs = new[]
{
"string",
},
Values = new[]
{
"string",
},
},
},
HostHdrs = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchHostHdrArgs
{
MatchCriteria = "string",
MatchCase = "string",
Values = new[]
{
"string",
},
},
},
IpReputationTypes = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchIpReputationTypeArgs
{
MatchOperation = "string",
ReputationTypes = new[]
{
"string",
},
},
},
Labels = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchLabelArgs
{
Values = new[]
{
"string",
},
MatchCriteria = "string",
},
},
Methods = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchMethodArgs
{
MatchCriteria = "string",
Methods = new[]
{
"string",
},
},
},
Paths = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchPathArgs
{
MatchCriteria = "string",
MatchCase = "string",
MatchDecodedString = "string",
MatchStrs = new[]
{
"string",
},
StringGroupRefs = new[]
{
"string",
},
},
},
Protocols = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchProtocolArgs
{
MatchCriteria = "string",
Protocols = "string",
},
},
Queries = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchQueryArgs
{
MatchCriteria = "string",
MatchCase = "string",
MatchDecodedString = "string",
MatchStrs = new[]
{
"string",
},
StringGroupRefs = new[]
{
"string",
},
},
},
SourceIps = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchSourceIpArgs
{
MatchCriteria = "string",
Addrs = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchSourceIpAddrArgs
{
Addr = "string",
Type = "string",
},
},
GroupRefs = new[]
{
"string",
},
Prefixes = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchSourceIpPrefixArgs
{
IpAddrs = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchSourceIpPrefixIpAddrArgs
{
Addr = "string",
Type = "string",
},
},
Mask = "string",
},
},
Ranges = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchSourceIpRangeArgs
{
Begins = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchSourceIpRangeBeginArgs
{
Addr = "string",
Type = "string",
},
},
Ends = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchSourceIpRangeEndArgs
{
Addr = "string",
Type = "string",
},
},
},
},
},
},
TlsFingerprintMatches = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchTlsFingerprintMatchArgs
{
MatchOperation = "string",
Fingerprints = new[]
{
"string",
},
StringGroupRefs = new[]
{
"string",
},
},
},
Versions = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchVersionArgs
{
MatchCriteria = "string",
Versions = new[]
{
"string",
},
},
},
VsPorts = new[]
{
new Avi.Inputs.ApipolicyRoutingInfoRuleMatchVsPortArgs
{
MatchCriteria = "string",
Ports = new[]
{
0.0,
},
},
},
},
},
Name = "string",
},
},
},
},
ServerInfos = new[]
{
new Avi.Inputs.ApipolicyServerInfoArgs
{
PathPrefix = "string",
Servers = new[]
{
new Avi.Inputs.ApipolicyServerInfoServerArgs
{
Url = "string",
Description = "string",
},
},
},
},
ShadowApiLabels = new[]
{
new Avi.Inputs.ApipolicyShadowApiLabelArgs
{
Enabled = "string",
Labels = new[]
{
"string",
},
},
},
TenantRef = "string",
Uuid = "string",
ValidationSettings = new[]
{
new Avi.Inputs.ApipolicyValidationSettingArgs
{
FailedValidationHeaderParameterAction = "string",
FailedValidationPathParameterAction = "string",
FailedValidationQueryArgumentAction = "string",
FailedValidationRequestBodyParameterAction = "string",
MissingMandatoryHeaderParameterAction = "string",
MissingMandatoryQueryArgumentAction = "string",
MissingMandatoryRequestBodyParameterAction = "string",
RequestOutsidePathPrefixAction = "string",
UnexpectedQueryArgumentAction = "string",
UnexpectedRequestBodyParameterAction = "string",
UnexpectedRequestHeaderAction = "string",
UnknownContentTypeAction = "string",
UnknownHttpMethodAction = "string",
UnknownPathAction = "string",
UnknownResponseContentTypeAction = "string",
UnknownResponseStatusCodeAction = "string",
},
},
ZombieApiClassificationSettings = new[]
{
new Avi.Inputs.ApipolicyZombieApiClassificationSettingArgs
{
Enabled = "string",
InspectionIntervalUnit = "string",
InspectionIntervalValue = "string",
MinPercent = "string",
},
},
ZombieApiLabels = new[]
{
new Avi.Inputs.ApipolicyZombieApiLabelArgs
{
Enabled = "string",
Labels = new[]
{
"string",
},
},
},
});
example, err := avi.NewApipolicy(ctx, "apipolicyResource", &avi.ApipolicyArgs{
ActiveApiLabels: avi.ApipolicyActiveApiLabelArray{
&avi.ApipolicyActiveApiLabelArgs{
Enabled: pulumi.String("string"),
Labels: pulumi.StringArray{
pulumi.String("string"),
},
},
},
ApiSpecInfos: avi.ApipolicyApiSpecInfoArray{
&avi.ApipolicyApiSpecInfoArgs{
ComponentSchemaCount: pulumi.String("string"),
Description: pulumi.String("string"),
InlineSchemaCount: pulumi.String("string"),
OasVersion: pulumi.String("string"),
PathCount: pulumi.String("string"),
Servers: avi.ApipolicyApiSpecInfoServerArray{
&avi.ApipolicyApiSpecInfoServerArgs{
Url: pulumi.String("string"),
Description: pulumi.String("string"),
},
},
Title: pulumi.String("string"),
Version: pulumi.String("string"),
},
},
ApipolicyId: pulumi.String("string"),
ConfigpbAttributes: avi.ApipolicyConfigpbAttributeArray{
&avi.ApipolicyConfigpbAttributeArgs{
CreatedBy: pulumi.String("string"),
Version: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
FileObjectRefs: pulumi.StringArray{
pulumi.String("string"),
},
LabelMappings: avi.ApipolicyLabelMappingArray{
&avi.ApipolicyLabelMappingArgs{
ApiPolicyActions: pulumi.StringArray{
pulumi.String("string"),
},
Label: pulumi.String("string"),
Enabled: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
NonApiUrlLabels: avi.ApipolicyNonApiUrlLabelArray{
&avi.ApipolicyNonApiUrlLabelArgs{
Enabled: pulumi.String("string"),
Labels: pulumi.StringArray{
pulumi.String("string"),
},
},
},
OrphanApiClassificationSettings: avi.ApipolicyOrphanApiClassificationSettingArray{
&avi.ApipolicyOrphanApiClassificationSettingArgs{
Enabled: pulumi.String("string"),
InspectionIntervalUnit: pulumi.String("string"),
InspectionIntervalValue: pulumi.String("string"),
},
},
OrphanApiLabels: avi.ApipolicyOrphanApiLabelArray{
&avi.ApipolicyOrphanApiLabelArgs{
Enabled: pulumi.String("string"),
Labels: pulumi.StringArray{
pulumi.String("string"),
},
},
},
PathRefs: pulumi.StringArray{
pulumi.String("string"),
},
RoutingInfos: avi.ApipolicyRoutingInfoArray{
&avi.ApipolicyRoutingInfoArgs{
Rules: avi.ApipolicyRoutingInfoRuleArray{
&avi.ApipolicyRoutingInfoRuleArgs{
Matches: avi.ApipolicyRoutingInfoRuleMatchArray{
&avi.ApipolicyRoutingInfoRuleMatchArgs{
BotDetectionResults: avi.ApipolicyRoutingInfoRuleMatchBotDetectionResultArray{
&avi.ApipolicyRoutingInfoRuleMatchBotDetectionResultArgs{
MatchOperation: pulumi.String("string"),
Classifications: avi.ApipolicyRoutingInfoRuleMatchBotDetectionResultClassificationArray{
&avi.ApipolicyRoutingInfoRuleMatchBotDetectionResultClassificationArgs{
Type: pulumi.String("string"),
UserDefinedType: pulumi.String("string"),
},
},
},
},
ClientIps: avi.ApipolicyRoutingInfoRuleMatchClientIpArray{
&avi.ApipolicyRoutingInfoRuleMatchClientIpArgs{
MatchCriteria: pulumi.String("string"),
Addrs: avi.ApipolicyRoutingInfoRuleMatchClientIpAddrArray{
&avi.ApipolicyRoutingInfoRuleMatchClientIpAddrArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
GroupRefs: pulumi.StringArray{
pulumi.String("string"),
},
Prefixes: avi.ApipolicyRoutingInfoRuleMatchClientIpPrefixArray{
&avi.ApipolicyRoutingInfoRuleMatchClientIpPrefixArgs{
IpAddrs: avi.ApipolicyRoutingInfoRuleMatchClientIpPrefixIpAddrArray{
&avi.ApipolicyRoutingInfoRuleMatchClientIpPrefixIpAddrArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Mask: pulumi.String("string"),
},
},
Ranges: avi.ApipolicyRoutingInfoRuleMatchClientIpRangeArray{
&avi.ApipolicyRoutingInfoRuleMatchClientIpRangeArgs{
Begins: avi.ApipolicyRoutingInfoRuleMatchClientIpRangeBeginArray{
&avi.ApipolicyRoutingInfoRuleMatchClientIpRangeBeginArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Ends: avi.ApipolicyRoutingInfoRuleMatchClientIpRangeEndArray{
&avi.ApipolicyRoutingInfoRuleMatchClientIpRangeEndArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
},
},
},
},
Cookies: avi.ApipolicyRoutingInfoRuleMatchCookieArray{
&avi.ApipolicyRoutingInfoRuleMatchCookieArgs{
MatchCriteria: pulumi.String("string"),
Name: pulumi.String("string"),
MatchCase: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
GeoMatches: avi.ApipolicyRoutingInfoRuleMatchGeoMatchArray{
&avi.ApipolicyRoutingInfoRuleMatchGeoMatchArgs{
Attribute: pulumi.String("string"),
MatchOperation: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Hdrs: avi.ApipolicyRoutingInfoRuleMatchHdrArray{
&avi.ApipolicyRoutingInfoRuleMatchHdrArgs{
Hdr: pulumi.String("string"),
MatchCriteria: pulumi.String("string"),
MatchCase: pulumi.String("string"),
StringGroupRefs: pulumi.StringArray{
pulumi.String("string"),
},
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
HostHdrs: avi.ApipolicyRoutingInfoRuleMatchHostHdrArray{
&avi.ApipolicyRoutingInfoRuleMatchHostHdrArgs{
MatchCriteria: pulumi.String("string"),
MatchCase: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
IpReputationTypes: avi.ApipolicyRoutingInfoRuleMatchIpReputationTypeArray{
&avi.ApipolicyRoutingInfoRuleMatchIpReputationTypeArgs{
MatchOperation: pulumi.String("string"),
ReputationTypes: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Labels: avi.ApipolicyRoutingInfoRuleMatchLabelArray{
&avi.ApipolicyRoutingInfoRuleMatchLabelArgs{
Values: pulumi.StringArray{
pulumi.String("string"),
},
MatchCriteria: pulumi.String("string"),
},
},
Methods: avi.ApipolicyRoutingInfoRuleMatchMethodArray{
&avi.ApipolicyRoutingInfoRuleMatchMethodArgs{
MatchCriteria: pulumi.String("string"),
Methods: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Paths: avi.ApipolicyRoutingInfoRuleMatchPathArray{
&avi.ApipolicyRoutingInfoRuleMatchPathArgs{
MatchCriteria: pulumi.String("string"),
MatchCase: pulumi.String("string"),
MatchDecodedString: pulumi.String("string"),
MatchStrs: pulumi.StringArray{
pulumi.String("string"),
},
StringGroupRefs: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: avi.ApipolicyRoutingInfoRuleMatchProtocolArray{
&avi.ApipolicyRoutingInfoRuleMatchProtocolArgs{
MatchCriteria: pulumi.String("string"),
Protocols: pulumi.String("string"),
},
},
Queries: avi.ApipolicyRoutingInfoRuleMatchQueryArray{
&avi.ApipolicyRoutingInfoRuleMatchQueryArgs{
MatchCriteria: pulumi.String("string"),
MatchCase: pulumi.String("string"),
MatchDecodedString: pulumi.String("string"),
MatchStrs: pulumi.StringArray{
pulumi.String("string"),
},
StringGroupRefs: pulumi.StringArray{
pulumi.String("string"),
},
},
},
SourceIps: avi.ApipolicyRoutingInfoRuleMatchSourceIpArray{
&avi.ApipolicyRoutingInfoRuleMatchSourceIpArgs{
MatchCriteria: pulumi.String("string"),
Addrs: avi.ApipolicyRoutingInfoRuleMatchSourceIpAddrArray{
&avi.ApipolicyRoutingInfoRuleMatchSourceIpAddrArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
GroupRefs: pulumi.StringArray{
pulumi.String("string"),
},
Prefixes: avi.ApipolicyRoutingInfoRuleMatchSourceIpPrefixArray{
&avi.ApipolicyRoutingInfoRuleMatchSourceIpPrefixArgs{
IpAddrs: avi.ApipolicyRoutingInfoRuleMatchSourceIpPrefixIpAddrArray{
&avi.ApipolicyRoutingInfoRuleMatchSourceIpPrefixIpAddrArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Mask: pulumi.String("string"),
},
},
Ranges: avi.ApipolicyRoutingInfoRuleMatchSourceIpRangeArray{
&avi.ApipolicyRoutingInfoRuleMatchSourceIpRangeArgs{
Begins: avi.ApipolicyRoutingInfoRuleMatchSourceIpRangeBeginArray{
&avi.ApipolicyRoutingInfoRuleMatchSourceIpRangeBeginArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Ends: avi.ApipolicyRoutingInfoRuleMatchSourceIpRangeEndArray{
&avi.ApipolicyRoutingInfoRuleMatchSourceIpRangeEndArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
},
},
},
},
TlsFingerprintMatches: avi.ApipolicyRoutingInfoRuleMatchTlsFingerprintMatchArray{
&avi.ApipolicyRoutingInfoRuleMatchTlsFingerprintMatchArgs{
MatchOperation: pulumi.String("string"),
Fingerprints: pulumi.StringArray{
pulumi.String("string"),
},
StringGroupRefs: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Versions: avi.ApipolicyRoutingInfoRuleMatchVersionArray{
&avi.ApipolicyRoutingInfoRuleMatchVersionArgs{
MatchCriteria: pulumi.String("string"),
Versions: pulumi.StringArray{
pulumi.String("string"),
},
},
},
VsPorts: avi.ApipolicyRoutingInfoRuleMatchVsPortArray{
&avi.ApipolicyRoutingInfoRuleMatchVsPortArgs{
MatchCriteria: pulumi.String("string"),
Ports: pulumi.Float64Array{
pulumi.Float64(0),
},
},
},
},
},
Name: pulumi.String("string"),
},
},
},
},
ServerInfos: avi.ApipolicyServerInfoArray{
&avi.ApipolicyServerInfoArgs{
PathPrefix: pulumi.String("string"),
Servers: avi.ApipolicyServerInfoServerArray{
&avi.ApipolicyServerInfoServerArgs{
Url: pulumi.String("string"),
Description: pulumi.String("string"),
},
},
},
},
ShadowApiLabels: avi.ApipolicyShadowApiLabelArray{
&avi.ApipolicyShadowApiLabelArgs{
Enabled: pulumi.String("string"),
Labels: pulumi.StringArray{
pulumi.String("string"),
},
},
},
TenantRef: pulumi.String("string"),
Uuid: pulumi.String("string"),
ValidationSettings: avi.ApipolicyValidationSettingArray{
&avi.ApipolicyValidationSettingArgs{
FailedValidationHeaderParameterAction: pulumi.String("string"),
FailedValidationPathParameterAction: pulumi.String("string"),
FailedValidationQueryArgumentAction: pulumi.String("string"),
FailedValidationRequestBodyParameterAction: pulumi.String("string"),
MissingMandatoryHeaderParameterAction: pulumi.String("string"),
MissingMandatoryQueryArgumentAction: pulumi.String("string"),
MissingMandatoryRequestBodyParameterAction: pulumi.String("string"),
RequestOutsidePathPrefixAction: pulumi.String("string"),
UnexpectedQueryArgumentAction: pulumi.String("string"),
UnexpectedRequestBodyParameterAction: pulumi.String("string"),
UnexpectedRequestHeaderAction: pulumi.String("string"),
UnknownContentTypeAction: pulumi.String("string"),
UnknownHttpMethodAction: pulumi.String("string"),
UnknownPathAction: pulumi.String("string"),
UnknownResponseContentTypeAction: pulumi.String("string"),
UnknownResponseStatusCodeAction: pulumi.String("string"),
},
},
ZombieApiClassificationSettings: avi.ApipolicyZombieApiClassificationSettingArray{
&avi.ApipolicyZombieApiClassificationSettingArgs{
Enabled: pulumi.String("string"),
InspectionIntervalUnit: pulumi.String("string"),
InspectionIntervalValue: pulumi.String("string"),
MinPercent: pulumi.String("string"),
},
},
ZombieApiLabels: avi.ApipolicyZombieApiLabelArray{
&avi.ApipolicyZombieApiLabelArgs{
Enabled: pulumi.String("string"),
Labels: pulumi.StringArray{
pulumi.String("string"),
},
},
},
})
resource "avi_apipolicy" "apipolicyResource" {
lifecycle {
create_before_destroy = true
}
active_api_labels {
enabled = "string"
labels = ["string"]
}
api_spec_infos {
component_schema_count = "string"
description = "string"
inline_schema_count = "string"
oas_version = "string"
path_count = "string"
servers {
url = "string"
description = "string"
}
title = "string"
version = "string"
}
apipolicy_id = "string"
configpb_attributes {
created_by = "string"
version = "string"
}
description = "string"
file_object_refs = ["string"]
label_mappings {
api_policy_actions = ["string"]
label = "string"
enabled = "string"
}
name = "string"
non_api_url_labels {
enabled = "string"
labels = ["string"]
}
orphan_api_classification_settings {
enabled = "string"
inspection_interval_unit = "string"
inspection_interval_value = "string"
}
orphan_api_labels {
enabled = "string"
labels = ["string"]
}
path_refs = ["string"]
routing_infos {
rules {
matches {
bot_detection_results {
match_operation = "string"
classifications {
type = "string"
user_defined_type = "string"
}
}
client_ips {
match_criteria = "string"
addrs {
addr = "string"
type = "string"
}
group_refs = ["string"]
prefixes {
ip_addrs {
addr = "string"
type = "string"
}
mask = "string"
}
ranges {
begins {
addr = "string"
type = "string"
}
ends {
addr = "string"
type = "string"
}
}
}
cookies {
match_criteria = "string"
name = "string"
match_case = "string"
value = "string"
}
geo_matches {
attribute = "string"
match_operation = "string"
values = ["string"]
}
hdrs {
hdr = "string"
match_criteria = "string"
match_case = "string"
string_group_refs = ["string"]
values = ["string"]
}
host_hdrs {
match_criteria = "string"
match_case = "string"
values = ["string"]
}
ip_reputation_types {
match_operation = "string"
reputation_types = ["string"]
}
labels {
values = ["string"]
match_criteria = "string"
}
methods {
match_criteria = "string"
methods = ["string"]
}
paths {
match_criteria = "string"
match_case = "string"
match_decoded_string = "string"
match_strs = ["string"]
string_group_refs = ["string"]
}
protocols {
match_criteria = "string"
protocols = "string"
}
queries {
match_criteria = "string"
match_case = "string"
match_decoded_string = "string"
match_strs = ["string"]
string_group_refs = ["string"]
}
source_ips {
match_criteria = "string"
addrs {
addr = "string"
type = "string"
}
group_refs = ["string"]
prefixes {
ip_addrs {
addr = "string"
type = "string"
}
mask = "string"
}
ranges {
begins {
addr = "string"
type = "string"
}
ends {
addr = "string"
type = "string"
}
}
}
tls_fingerprint_matches {
match_operation = "string"
fingerprints = ["string"]
string_group_refs = ["string"]
}
versions {
match_criteria = "string"
versions = ["string"]
}
vs_ports {
match_criteria = "string"
ports = [0]
}
}
name = "string"
}
}
server_infos {
path_prefix = "string"
servers {
url = "string"
description = "string"
}
}
shadow_api_labels {
enabled = "string"
labels = ["string"]
}
tenant_ref = "string"
uuid = "string"
validation_settings {
failed_validation_header_parameter_action = "string"
failed_validation_path_parameter_action = "string"
failed_validation_query_argument_action = "string"
failed_validation_request_body_parameter_action = "string"
missing_mandatory_header_parameter_action = "string"
missing_mandatory_query_argument_action = "string"
missing_mandatory_request_body_parameter_action = "string"
request_outside_path_prefix_action = "string"
unexpected_query_argument_action = "string"
unexpected_request_body_parameter_action = "string"
unexpected_request_header_action = "string"
unknown_content_type_action = "string"
unknown_http_method_action = "string"
unknown_path_action = "string"
unknown_response_content_type_action = "string"
unknown_response_status_code_action = "string"
}
zombie_api_classification_settings {
enabled = "string"
inspection_interval_unit = "string"
inspection_interval_value = "string"
min_percent = "string"
}
zombie_api_labels {
enabled = "string"
labels = ["string"]
}
}
var apipolicyResource = new Apipolicy("apipolicyResource", ApipolicyArgs.builder()
.activeApiLabels(ApipolicyActiveApiLabelArgs.builder()
.enabled("string")
.labels("string")
.build())
.apiSpecInfos(ApipolicyApiSpecInfoArgs.builder()
.componentSchemaCount("string")
.description("string")
.inlineSchemaCount("string")
.oasVersion("string")
.pathCount("string")
.servers(ApipolicyApiSpecInfoServerArgs.builder()
.url("string")
.description("string")
.build())
.title("string")
.version("string")
.build())
.apipolicyId("string")
.configpbAttributes(ApipolicyConfigpbAttributeArgs.builder()
.createdBy("string")
.version("string")
.build())
.description("string")
.fileObjectRefs("string")
.labelMappings(ApipolicyLabelMappingArgs.builder()
.apiPolicyActions("string")
.label("string")
.enabled("string")
.build())
.name("string")
.nonApiUrlLabels(ApipolicyNonApiUrlLabelArgs.builder()
.enabled("string")
.labels("string")
.build())
.orphanApiClassificationSettings(ApipolicyOrphanApiClassificationSettingArgs.builder()
.enabled("string")
.inspectionIntervalUnit("string")
.inspectionIntervalValue("string")
.build())
.orphanApiLabels(ApipolicyOrphanApiLabelArgs.builder()
.enabled("string")
.labels("string")
.build())
.pathRefs("string")
.routingInfos(ApipolicyRoutingInfoArgs.builder()
.rules(ApipolicyRoutingInfoRuleArgs.builder()
.matches(ApipolicyRoutingInfoRuleMatchArgs.builder()
.botDetectionResults(ApipolicyRoutingInfoRuleMatchBotDetectionResultArgs.builder()
.matchOperation("string")
.classifications(ApipolicyRoutingInfoRuleMatchBotDetectionResultClassificationArgs.builder()
.type("string")
.userDefinedType("string")
.build())
.build())
.clientIps(ApipolicyRoutingInfoRuleMatchClientIpArgs.builder()
.matchCriteria("string")
.addrs(ApipolicyRoutingInfoRuleMatchClientIpAddrArgs.builder()
.addr("string")
.type("string")
.build())
.groupRefs("string")
.prefixes(ApipolicyRoutingInfoRuleMatchClientIpPrefixArgs.builder()
.ipAddrs(ApipolicyRoutingInfoRuleMatchClientIpPrefixIpAddrArgs.builder()
.addr("string")
.type("string")
.build())
.mask("string")
.build())
.ranges(ApipolicyRoutingInfoRuleMatchClientIpRangeArgs.builder()
.begins(ApipolicyRoutingInfoRuleMatchClientIpRangeBeginArgs.builder()
.addr("string")
.type("string")
.build())
.ends(ApipolicyRoutingInfoRuleMatchClientIpRangeEndArgs.builder()
.addr("string")
.type("string")
.build())
.build())
.build())
.cookies(ApipolicyRoutingInfoRuleMatchCookieArgs.builder()
.matchCriteria("string")
.name("string")
.matchCase("string")
.value("string")
.build())
.geoMatches(ApipolicyRoutingInfoRuleMatchGeoMatchArgs.builder()
.attribute("string")
.matchOperation("string")
.values("string")
.build())
.hdrs(ApipolicyRoutingInfoRuleMatchHdrArgs.builder()
.hdr("string")
.matchCriteria("string")
.matchCase("string")
.stringGroupRefs("string")
.values("string")
.build())
.hostHdrs(ApipolicyRoutingInfoRuleMatchHostHdrArgs.builder()
.matchCriteria("string")
.matchCase("string")
.values("string")
.build())
.ipReputationTypes(ApipolicyRoutingInfoRuleMatchIpReputationTypeArgs.builder()
.matchOperation("string")
.reputationTypes("string")
.build())
.labels(ApipolicyRoutingInfoRuleMatchLabelArgs.builder()
.values("string")
.matchCriteria("string")
.build())
.methods(ApipolicyRoutingInfoRuleMatchMethodArgs.builder()
.matchCriteria("string")
.methods("string")
.build())
.paths(ApipolicyRoutingInfoRuleMatchPathArgs.builder()
.matchCriteria("string")
.matchCase("string")
.matchDecodedString("string")
.matchStrs("string")
.stringGroupRefs("string")
.build())
.protocols(ApipolicyRoutingInfoRuleMatchProtocolArgs.builder()
.matchCriteria("string")
.protocols("string")
.build())
.queries(ApipolicyRoutingInfoRuleMatchQueryArgs.builder()
.matchCriteria("string")
.matchCase("string")
.matchDecodedString("string")
.matchStrs("string")
.stringGroupRefs("string")
.build())
.sourceIps(ApipolicyRoutingInfoRuleMatchSourceIpArgs.builder()
.matchCriteria("string")
.addrs(ApipolicyRoutingInfoRuleMatchSourceIpAddrArgs.builder()
.addr("string")
.type("string")
.build())
.groupRefs("string")
.prefixes(ApipolicyRoutingInfoRuleMatchSourceIpPrefixArgs.builder()
.ipAddrs(ApipolicyRoutingInfoRuleMatchSourceIpPrefixIpAddrArgs.builder()
.addr("string")
.type("string")
.build())
.mask("string")
.build())
.ranges(ApipolicyRoutingInfoRuleMatchSourceIpRangeArgs.builder()
.begins(ApipolicyRoutingInfoRuleMatchSourceIpRangeBeginArgs.builder()
.addr("string")
.type("string")
.build())
.ends(ApipolicyRoutingInfoRuleMatchSourceIpRangeEndArgs.builder()
.addr("string")
.type("string")
.build())
.build())
.build())
.tlsFingerprintMatches(ApipolicyRoutingInfoRuleMatchTlsFingerprintMatchArgs.builder()
.matchOperation("string")
.fingerprints("string")
.stringGroupRefs("string")
.build())
.versions(ApipolicyRoutingInfoRuleMatchVersionArgs.builder()
.matchCriteria("string")
.versions("string")
.build())
.vsPorts(ApipolicyRoutingInfoRuleMatchVsPortArgs.builder()
.matchCriteria("string")
.ports(0.0)
.build())
.build())
.name("string")
.build())
.build())
.serverInfos(ApipolicyServerInfoArgs.builder()
.pathPrefix("string")
.servers(ApipolicyServerInfoServerArgs.builder()
.url("string")
.description("string")
.build())
.build())
.shadowApiLabels(ApipolicyShadowApiLabelArgs.builder()
.enabled("string")
.labels("string")
.build())
.tenantRef("string")
.uuid("string")
.validationSettings(ApipolicyValidationSettingArgs.builder()
.failedValidationHeaderParameterAction("string")
.failedValidationPathParameterAction("string")
.failedValidationQueryArgumentAction("string")
.failedValidationRequestBodyParameterAction("string")
.missingMandatoryHeaderParameterAction("string")
.missingMandatoryQueryArgumentAction("string")
.missingMandatoryRequestBodyParameterAction("string")
.requestOutsidePathPrefixAction("string")
.unexpectedQueryArgumentAction("string")
.unexpectedRequestBodyParameterAction("string")
.unexpectedRequestHeaderAction("string")
.unknownContentTypeAction("string")
.unknownHttpMethodAction("string")
.unknownPathAction("string")
.unknownResponseContentTypeAction("string")
.unknownResponseStatusCodeAction("string")
.build())
.zombieApiClassificationSettings(ApipolicyZombieApiClassificationSettingArgs.builder()
.enabled("string")
.inspectionIntervalUnit("string")
.inspectionIntervalValue("string")
.minPercent("string")
.build())
.zombieApiLabels(ApipolicyZombieApiLabelArgs.builder()
.enabled("string")
.labels("string")
.build())
.build());
apipolicy_resource = avi.Apipolicy("apipolicyResource",
active_api_labels=[{
"enabled": "string",
"labels": ["string"],
}],
api_spec_infos=[{
"component_schema_count": "string",
"description": "string",
"inline_schema_count": "string",
"oas_version": "string",
"path_count": "string",
"servers": [{
"url": "string",
"description": "string",
}],
"title": "string",
"version": "string",
}],
apipolicy_id="string",
configpb_attributes=[{
"created_by": "string",
"version": "string",
}],
description="string",
file_object_refs=["string"],
label_mappings=[{
"api_policy_actions": ["string"],
"label": "string",
"enabled": "string",
}],
name="string",
non_api_url_labels=[{
"enabled": "string",
"labels": ["string"],
}],
orphan_api_classification_settings=[{
"enabled": "string",
"inspection_interval_unit": "string",
"inspection_interval_value": "string",
}],
orphan_api_labels=[{
"enabled": "string",
"labels": ["string"],
}],
path_refs=["string"],
routing_infos=[{
"rules": [{
"matches": [{
"bot_detection_results": [{
"match_operation": "string",
"classifications": [{
"type": "string",
"user_defined_type": "string",
}],
}],
"client_ips": [{
"match_criteria": "string",
"addrs": [{
"addr": "string",
"type": "string",
}],
"group_refs": ["string"],
"prefixes": [{
"ip_addrs": [{
"addr": "string",
"type": "string",
}],
"mask": "string",
}],
"ranges": [{
"begins": [{
"addr": "string",
"type": "string",
}],
"ends": [{
"addr": "string",
"type": "string",
}],
}],
}],
"cookies": [{
"match_criteria": "string",
"name": "string",
"match_case": "string",
"value": "string",
}],
"geo_matches": [{
"attribute": "string",
"match_operation": "string",
"values": ["string"],
}],
"hdrs": [{
"hdr": "string",
"match_criteria": "string",
"match_case": "string",
"string_group_refs": ["string"],
"values": ["string"],
}],
"host_hdrs": [{
"match_criteria": "string",
"match_case": "string",
"values": ["string"],
}],
"ip_reputation_types": [{
"match_operation": "string",
"reputation_types": ["string"],
}],
"labels": [{
"values": ["string"],
"match_criteria": "string",
}],
"methods": [{
"match_criteria": "string",
"methods": ["string"],
}],
"paths": [{
"match_criteria": "string",
"match_case": "string",
"match_decoded_string": "string",
"match_strs": ["string"],
"string_group_refs": ["string"],
}],
"protocols": [{
"match_criteria": "string",
"protocols": "string",
}],
"queries": [{
"match_criteria": "string",
"match_case": "string",
"match_decoded_string": "string",
"match_strs": ["string"],
"string_group_refs": ["string"],
}],
"source_ips": [{
"match_criteria": "string",
"addrs": [{
"addr": "string",
"type": "string",
}],
"group_refs": ["string"],
"prefixes": [{
"ip_addrs": [{
"addr": "string",
"type": "string",
}],
"mask": "string",
}],
"ranges": [{
"begins": [{
"addr": "string",
"type": "string",
}],
"ends": [{
"addr": "string",
"type": "string",
}],
}],
}],
"tls_fingerprint_matches": [{
"match_operation": "string",
"fingerprints": ["string"],
"string_group_refs": ["string"],
}],
"versions": [{
"match_criteria": "string",
"versions": ["string"],
}],
"vs_ports": [{
"match_criteria": "string",
"ports": [float(0)],
}],
}],
"name": "string",
}],
}],
server_infos=[{
"path_prefix": "string",
"servers": [{
"url": "string",
"description": "string",
}],
}],
shadow_api_labels=[{
"enabled": "string",
"labels": ["string"],
}],
tenant_ref="string",
uuid="string",
validation_settings=[{
"failed_validation_header_parameter_action": "string",
"failed_validation_path_parameter_action": "string",
"failed_validation_query_argument_action": "string",
"failed_validation_request_body_parameter_action": "string",
"missing_mandatory_header_parameter_action": "string",
"missing_mandatory_query_argument_action": "string",
"missing_mandatory_request_body_parameter_action": "string",
"request_outside_path_prefix_action": "string",
"unexpected_query_argument_action": "string",
"unexpected_request_body_parameter_action": "string",
"unexpected_request_header_action": "string",
"unknown_content_type_action": "string",
"unknown_http_method_action": "string",
"unknown_path_action": "string",
"unknown_response_content_type_action": "string",
"unknown_response_status_code_action": "string",
}],
zombie_api_classification_settings=[{
"enabled": "string",
"inspection_interval_unit": "string",
"inspection_interval_value": "string",
"min_percent": "string",
}],
zombie_api_labels=[{
"enabled": "string",
"labels": ["string"],
}])
const apipolicyResource = new avi.Apipolicy("apipolicyResource", {
activeApiLabels: [{
enabled: "string",
labels: ["string"],
}],
apiSpecInfos: [{
componentSchemaCount: "string",
description: "string",
inlineSchemaCount: "string",
oasVersion: "string",
pathCount: "string",
servers: [{
url: "string",
description: "string",
}],
title: "string",
version: "string",
}],
apipolicyId: "string",
configpbAttributes: [{
createdBy: "string",
version: "string",
}],
description: "string",
fileObjectRefs: ["string"],
labelMappings: [{
apiPolicyActions: ["string"],
label: "string",
enabled: "string",
}],
name: "string",
nonApiUrlLabels: [{
enabled: "string",
labels: ["string"],
}],
orphanApiClassificationSettings: [{
enabled: "string",
inspectionIntervalUnit: "string",
inspectionIntervalValue: "string",
}],
orphanApiLabels: [{
enabled: "string",
labels: ["string"],
}],
pathRefs: ["string"],
routingInfos: [{
rules: [{
matches: [{
botDetectionResults: [{
matchOperation: "string",
classifications: [{
type: "string",
userDefinedType: "string",
}],
}],
clientIps: [{
matchCriteria: "string",
addrs: [{
addr: "string",
type: "string",
}],
groupRefs: ["string"],
prefixes: [{
ipAddrs: [{
addr: "string",
type: "string",
}],
mask: "string",
}],
ranges: [{
begins: [{
addr: "string",
type: "string",
}],
ends: [{
addr: "string",
type: "string",
}],
}],
}],
cookies: [{
matchCriteria: "string",
name: "string",
matchCase: "string",
value: "string",
}],
geoMatches: [{
attribute: "string",
matchOperation: "string",
values: ["string"],
}],
hdrs: [{
hdr: "string",
matchCriteria: "string",
matchCase: "string",
stringGroupRefs: ["string"],
values: ["string"],
}],
hostHdrs: [{
matchCriteria: "string",
matchCase: "string",
values: ["string"],
}],
ipReputationTypes: [{
matchOperation: "string",
reputationTypes: ["string"],
}],
labels: [{
values: ["string"],
matchCriteria: "string",
}],
methods: [{
matchCriteria: "string",
methods: ["string"],
}],
paths: [{
matchCriteria: "string",
matchCase: "string",
matchDecodedString: "string",
matchStrs: ["string"],
stringGroupRefs: ["string"],
}],
protocols: [{
matchCriteria: "string",
protocols: "string",
}],
queries: [{
matchCriteria: "string",
matchCase: "string",
matchDecodedString: "string",
matchStrs: ["string"],
stringGroupRefs: ["string"],
}],
sourceIps: [{
matchCriteria: "string",
addrs: [{
addr: "string",
type: "string",
}],
groupRefs: ["string"],
prefixes: [{
ipAddrs: [{
addr: "string",
type: "string",
}],
mask: "string",
}],
ranges: [{
begins: [{
addr: "string",
type: "string",
}],
ends: [{
addr: "string",
type: "string",
}],
}],
}],
tlsFingerprintMatches: [{
matchOperation: "string",
fingerprints: ["string"],
stringGroupRefs: ["string"],
}],
versions: [{
matchCriteria: "string",
versions: ["string"],
}],
vsPorts: [{
matchCriteria: "string",
ports: [0],
}],
}],
name: "string",
}],
}],
serverInfos: [{
pathPrefix: "string",
servers: [{
url: "string",
description: "string",
}],
}],
shadowApiLabels: [{
enabled: "string",
labels: ["string"],
}],
tenantRef: "string",
uuid: "string",
validationSettings: [{
failedValidationHeaderParameterAction: "string",
failedValidationPathParameterAction: "string",
failedValidationQueryArgumentAction: "string",
failedValidationRequestBodyParameterAction: "string",
missingMandatoryHeaderParameterAction: "string",
missingMandatoryQueryArgumentAction: "string",
missingMandatoryRequestBodyParameterAction: "string",
requestOutsidePathPrefixAction: "string",
unexpectedQueryArgumentAction: "string",
unexpectedRequestBodyParameterAction: "string",
unexpectedRequestHeaderAction: "string",
unknownContentTypeAction: "string",
unknownHttpMethodAction: "string",
unknownPathAction: "string",
unknownResponseContentTypeAction: "string",
unknownResponseStatusCodeAction: "string",
}],
zombieApiClassificationSettings: [{
enabled: "string",
inspectionIntervalUnit: "string",
inspectionIntervalValue: "string",
minPercent: "string",
}],
zombieApiLabels: [{
enabled: "string",
labels: ["string"],
}],
});
type: avi:Apipolicy
properties:
activeApiLabels:
- enabled: string
labels:
- string
apiSpecInfos:
- componentSchemaCount: string
description: string
inlineSchemaCount: string
oasVersion: string
pathCount: string
servers:
- description: string
url: string
title: string
version: string
apipolicyId: string
configpbAttributes:
- createdBy: string
version: string
description: string
fileObjectRefs:
- string
labelMappings:
- apiPolicyActions:
- string
enabled: string
label: string
name: string
nonApiUrlLabels:
- enabled: string
labels:
- string
orphanApiClassificationSettings:
- enabled: string
inspectionIntervalUnit: string
inspectionIntervalValue: string
orphanApiLabels:
- enabled: string
labels:
- string
pathRefs:
- string
routingInfos:
- rules:
- matches:
- botDetectionResults:
- classifications:
- type: string
userDefinedType: string
matchOperation: string
clientIps:
- addrs:
- addr: string
type: string
groupRefs:
- string
matchCriteria: string
prefixes:
- ipAddrs:
- addr: string
type: string
mask: string
ranges:
- begins:
- addr: string
type: string
ends:
- addr: string
type: string
cookies:
- matchCase: string
matchCriteria: string
name: string
value: string
geoMatches:
- attribute: string
matchOperation: string
values:
- string
hdrs:
- hdr: string
matchCase: string
matchCriteria: string
stringGroupRefs:
- string
values:
- string
hostHdrs:
- matchCase: string
matchCriteria: string
values:
- string
ipReputationTypes:
- matchOperation: string
reputationTypes:
- string
labels:
- matchCriteria: string
values:
- string
methods:
- matchCriteria: string
methods:
- string
paths:
- matchCase: string
matchCriteria: string
matchDecodedString: string
matchStrs:
- string
stringGroupRefs:
- string
protocols:
- matchCriteria: string
protocols: string
queries:
- matchCase: string
matchCriteria: string
matchDecodedString: string
matchStrs:
- string
stringGroupRefs:
- string
sourceIps:
- addrs:
- addr: string
type: string
groupRefs:
- string
matchCriteria: string
prefixes:
- ipAddrs:
- addr: string
type: string
mask: string
ranges:
- begins:
- addr: string
type: string
ends:
- addr: string
type: string
tlsFingerprintMatches:
- fingerprints:
- string
matchOperation: string
stringGroupRefs:
- string
versions:
- matchCriteria: string
versions:
- string
vsPorts:
- matchCriteria: string
ports:
- 0
name: string
serverInfos:
- pathPrefix: string
servers:
- description: string
url: string
shadowApiLabels:
- enabled: string
labels:
- string
tenantRef: string
uuid: string
validationSettings:
- failedValidationHeaderParameterAction: string
failedValidationPathParameterAction: string
failedValidationQueryArgumentAction: string
failedValidationRequestBodyParameterAction: string
missingMandatoryHeaderParameterAction: string
missingMandatoryQueryArgumentAction: string
missingMandatoryRequestBodyParameterAction: string
requestOutsidePathPrefixAction: string
unexpectedQueryArgumentAction: string
unexpectedRequestBodyParameterAction: string
unexpectedRequestHeaderAction: string
unknownContentTypeAction: string
unknownHttpMethodAction: string
unknownPathAction: string
unknownResponseContentTypeAction: string
unknownResponseStatusCodeAction: string
zombieApiClassificationSettings:
- enabled: string
inspectionIntervalUnit: string
inspectionIntervalValue: string
minPercent: string
zombieApiLabels:
- enabled: string
labels:
- string
Apipolicy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Apipolicy resource accepts the following input properties:
- Active
Api List<ApipolicyLabels Active Api Label> - 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 List<ApipolicyInfos Api Spec Info> - 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.
- Apipolicy
Id string - Configpb
Attributes List<ApipolicyConfigpb Attribute> - 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 List<string>Refs - 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.
- Label
Mappings List<ApipolicyLabel Mapping> - 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 List<ApipolicyUrl Labels Non Api Url Label> - 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 List<ApipolicyClassification Settings Orphan Api Classification Setting> - 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 List<ApipolicyLabels Orphan Api Label> - 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<ApipolicyRouting Info> - 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<ApipolicyServer Info> - 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 List<ApipolicyLabels Shadow Api Label> - 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<ApipolicyValidation Setting> - 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 List<ApipolicyClassification Settings Zombie Api Classification Setting> - 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 List<ApipolicyLabels Zombie Api Label> - 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 []ApipolicyLabels Active Api Label Args - 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 []ApipolicyInfos Api Spec Info Args - 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.
- Apipolicy
Id string - Configpb
Attributes []ApipolicyConfigpb Attribute Args - 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 []stringRefs - 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.
- Label
Mappings []ApipolicyLabel Mapping Args - 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 []ApipolicyUrl Labels Non Api Url Label Args - 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 []ApipolicyClassification Settings Orphan Api Classification Setting Args - 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 []ApipolicyLabels Orphan Api Label Args - 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 []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 []ApipolicyRouting Info Args - 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 []ApipolicyServer Info Args - 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 []ApipolicyLabels Shadow Api Label Args - 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 []ApipolicyValidation Setting Args - 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 []ApipolicyClassification Settings Zombie Api Classification Setting Args - 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 []ApipolicyLabels Zombie Api Label Args - 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_ list(object)labels - 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_ list(object)infos - 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.
- apipolicy_
id string - configpb_
attributes list(object) - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description string
- Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- file_
object_ list(string)refs - 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.
- 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_ list(object)url_ labels - 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_ list(object)classification_ settings - 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_ list(object)labels - 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_ list(object)labels - 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_ list(object)classification_ settings - 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_ list(object)labels - 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 List<ApipolicyLabels Active Api Label> - 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 List<ApipolicyInfos Api Spec Info> - 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.
- apipolicy
Id String - configpb
Attributes List<ApipolicyConfigpb Attribute> - 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 List<String>Refs - 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.
- label
Mappings List<ApipolicyLabel Mapping> - 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 List<ApipolicyUrl Labels Non Api Url Label> - 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 List<ApipolicyClassification Settings Orphan Api Classification Setting> - 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 List<ApipolicyLabels Orphan Api Label> - 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<ApipolicyRouting Info> - 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<ApipolicyServer Info> - 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 List<ApipolicyLabels Shadow Api Label> - 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<ApipolicyValidation Setting> - 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 List<ApipolicyClassification Settings Zombie Api Classification Setting> - 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 List<ApipolicyLabels Zombie Api Label> - 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 ApipolicyLabels Active Api Label[] - 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 ApipolicyInfos Api Spec Info[] - 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.
- apipolicy
Id string - configpb
Attributes ApipolicyConfigpb Attribute[] - 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 string[]Refs - 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.
- label
Mappings ApipolicyLabel Mapping[] - 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 ApipolicyUrl Labels Non Api Url Label[] - 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 ApipolicyClassification Settings Orphan Api Classification Setting[] - 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 ApipolicyLabels Orphan Api Label[] - 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 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 ApipolicyRouting Info[] - 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 ApipolicyServer Info[] - 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 ApipolicyLabels Shadow Api Label[] - 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 ApipolicyValidation Setting[] - 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 ApipolicyClassification Settings Zombie Api Classification Setting[] - 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 ApipolicyLabels Zombie Api Label[] - 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_ Sequence[Apipolicylabels Active Api Label Args] - 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_ Sequence[Apipolicyinfos Api Spec Info Args] - 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.
- apipolicy_
id str - configpb_
attributes Sequence[ApipolicyConfigpb Attribute Args] - 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_ Sequence[str]refs - 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.
- label_
mappings Sequence[ApipolicyLabel Mapping Args] - 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_ Sequence[Apipolicyurl_ labels Non Api Url Label Args] - 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_ Sequence[Apipolicyclassification_ settings Orphan Api Classification Setting Args] - 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_ Sequence[Apipolicylabels Orphan Api Label Args] - 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[ApipolicyRouting Info Args] - 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[ApipolicyServer Info Args] - 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_ Sequence[Apipolicylabels Shadow Api Label Args] - 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[ApipolicyValidation Setting Args] - 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_ Sequence[Apipolicyclassification_ settings Zombie Api Classification Setting Args] - 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_ Sequence[Apipolicylabels Zombie Api Label Args] - 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 List<Property Map>Labels - 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 List<Property Map>Infos - 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.
- apipolicy
Id String - configpb
Attributes 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.
- file
Object List<String>Refs - 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.
- label
Mappings 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.
- non
Api List<Property Map>Url Labels - 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 List<Property Map>Classification Settings - 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 List<Property Map>Labels - 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<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.
- server
Infos 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.
- shadow
Api List<Property Map>Labels - 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<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.
- zombie
Api List<Property Map>Classification Settings - 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 List<Property Map>Labels - 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the Apipolicy resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Apipolicy Resource
Get an existing Apipolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ApipolicyState, opts?: CustomResourceOptions): Apipolicy@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
active_api_labels: Optional[Sequence[ApipolicyActiveApiLabelArgs]] = None,
api_spec_infos: Optional[Sequence[ApipolicyApiSpecInfoArgs]] = None,
apipolicy_id: Optional[str] = None,
configpb_attributes: Optional[Sequence[ApipolicyConfigpbAttributeArgs]] = None,
description: Optional[str] = None,
file_object_refs: Optional[Sequence[str]] = None,
label_mappings: Optional[Sequence[ApipolicyLabelMappingArgs]] = None,
name: Optional[str] = None,
non_api_url_labels: Optional[Sequence[ApipolicyNonApiUrlLabelArgs]] = None,
orphan_api_classification_settings: Optional[Sequence[ApipolicyOrphanApiClassificationSettingArgs]] = None,
orphan_api_labels: Optional[Sequence[ApipolicyOrphanApiLabelArgs]] = None,
path_refs: Optional[Sequence[str]] = None,
routing_infos: Optional[Sequence[ApipolicyRoutingInfoArgs]] = None,
server_infos: Optional[Sequence[ApipolicyServerInfoArgs]] = None,
shadow_api_labels: Optional[Sequence[ApipolicyShadowApiLabelArgs]] = None,
tenant_ref: Optional[str] = None,
uuid: Optional[str] = None,
validation_settings: Optional[Sequence[ApipolicyValidationSettingArgs]] = None,
zombie_api_classification_settings: Optional[Sequence[ApipolicyZombieApiClassificationSettingArgs]] = None,
zombie_api_labels: Optional[Sequence[ApipolicyZombieApiLabelArgs]] = None) -> Apipolicyfunc GetApipolicy(ctx *Context, name string, id IDInput, state *ApipolicyState, opts ...ResourceOption) (*Apipolicy, error)public static Apipolicy Get(string name, Input<string> id, ApipolicyState? state, CustomResourceOptions? opts = null)public static Apipolicy get(String name, Output<String> id, ApipolicyState state, CustomResourceOptions options)resources: _: type: avi:Apipolicy get: id: ${id}import {
to = avi_apipolicy.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Active
Api List<ApipolicyLabels Active Api Label> - 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 List<ApipolicyInfos Api Spec Info> - 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.
- Apipolicy
Id string - Configpb
Attributes List<ApipolicyConfigpb Attribute> - 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 List<string>Refs - 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.
- Label
Mappings List<ApipolicyLabel Mapping> - 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 List<ApipolicyUrl Labels Non Api Url Label> - 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 List<ApipolicyClassification Settings Orphan Api Classification Setting> - 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 List<ApipolicyLabels Orphan Api Label> - 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<ApipolicyRouting Info> - 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<ApipolicyServer Info> - 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 List<ApipolicyLabels Shadow Api Label> - 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<ApipolicyValidation Setting> - 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 List<ApipolicyClassification Settings Zombie Api Classification Setting> - 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 List<ApipolicyLabels Zombie Api Label> - 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 []ApipolicyLabels Active Api Label Args - 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 []ApipolicyInfos Api Spec Info Args - 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.
- Apipolicy
Id string - Configpb
Attributes []ApipolicyConfigpb Attribute Args - 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 []stringRefs - 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.
- Label
Mappings []ApipolicyLabel Mapping Args - 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 []ApipolicyUrl Labels Non Api Url Label Args - 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 []ApipolicyClassification Settings Orphan Api Classification Setting Args - 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 []ApipolicyLabels Orphan Api Label Args - 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 []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 []ApipolicyRouting Info Args - 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 []ApipolicyServer Info Args - 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 []ApipolicyLabels Shadow Api Label Args - 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 []ApipolicyValidation Setting Args - 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 []ApipolicyClassification Settings Zombie Api Classification Setting Args - 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 []ApipolicyLabels Zombie Api Label Args - 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_ list(object)labels - 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_ list(object)infos - 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.
- apipolicy_
id string - configpb_
attributes list(object) - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description string
- Description of this api policy. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- file_
object_ list(string)refs - 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.
- 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_ list(object)url_ labels - 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_ list(object)classification_ settings - 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_ list(object)labels - 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_ list(object)labels - 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_ list(object)classification_ settings - 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_ list(object)labels - 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 List<ApipolicyLabels Active Api Label> - 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 List<ApipolicyInfos Api Spec Info> - 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.
- apipolicy
Id String - configpb
Attributes List<ApipolicyConfigpb Attribute> - 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 List<String>Refs - 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.
- label
Mappings List<ApipolicyLabel Mapping> - 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 List<ApipolicyUrl Labels Non Api Url Label> - 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 List<ApipolicyClassification Settings Orphan Api Classification Setting> - 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 List<ApipolicyLabels Orphan Api Label> - 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<ApipolicyRouting Info> - 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<ApipolicyServer Info> - 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 List<ApipolicyLabels Shadow Api Label> - 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<ApipolicyValidation Setting> - 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 List<ApipolicyClassification Settings Zombie Api Classification Setting> - 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 List<ApipolicyLabels Zombie Api Label> - 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 ApipolicyLabels Active Api Label[] - 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 ApipolicyInfos Api Spec Info[] - 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.
- apipolicy
Id string - configpb
Attributes ApipolicyConfigpb Attribute[] - 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 string[]Refs - 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.
- label
Mappings ApipolicyLabel Mapping[] - 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 ApipolicyUrl Labels Non Api Url Label[] - 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 ApipolicyClassification Settings Orphan Api Classification Setting[] - 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 ApipolicyLabels Orphan Api Label[] - 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 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 ApipolicyRouting Info[] - 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 ApipolicyServer Info[] - 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 ApipolicyLabels Shadow Api Label[] - 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 ApipolicyValidation Setting[] - 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 ApipolicyClassification Settings Zombie Api Classification Setting[] - 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 ApipolicyLabels Zombie Api Label[] - 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_ Sequence[Apipolicylabels Active Api Label Args] - 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_ Sequence[Apipolicyinfos Api Spec Info Args] - 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.
- apipolicy_
id str - configpb_
attributes Sequence[ApipolicyConfigpb Attribute Args] - 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_ Sequence[str]refs - 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.
- label_
mappings Sequence[ApipolicyLabel Mapping Args] - 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_ Sequence[Apipolicyurl_ labels Non Api Url Label Args] - 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_ Sequence[Apipolicyclassification_ settings Orphan Api Classification Setting Args] - 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_ Sequence[Apipolicylabels Orphan Api Label Args] - 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[ApipolicyRouting Info Args] - 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[ApipolicyServer Info Args] - 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_ Sequence[Apipolicylabels Shadow Api Label Args] - 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[ApipolicyValidation Setting Args] - 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_ Sequence[Apipolicyclassification_ settings Zombie Api Classification Setting Args] - 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_ Sequence[Apipolicylabels Zombie Api Label Args] - 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 List<Property Map>Labels - 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 List<Property Map>Infos - 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.
- apipolicy
Id String - configpb
Attributes 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.
- file
Object List<String>Refs - 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.
- label
Mappings 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.
- non
Api List<Property Map>Url Labels - 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 List<Property Map>Classification Settings - 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 List<Property Map>Labels - 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<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.
- server
Infos 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.
- shadow
Api List<Property Map>Labels - 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<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.
- zombie
Api List<Property Map>Classification Settings - 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 List<Property Map>Labels - 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
ApipolicyActiveApiLabel, ApipolicyActiveApiLabelArgs
ApipolicyApiSpecInfo, ApipolicyApiSpecInfoArgs
- Component
Schema stringCount - 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 stringCount - Oas
Version string - Path
Count string - Servers
List<Apipolicy
Api Spec Info Server> - Title string
- Version string
- Component
Schema stringCount - 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 stringCount - Oas
Version string - Path
Count string - Servers
[]Apipolicy
Api Spec Info Server - Title string
- Version string
- component_
schema_ stringcount - 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_ stringcount - oas_
version string - path_
count string - servers list(object)
- title string
- version string
- component
Schema StringCount - 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 StringCount - oas
Version String - path
Count String - servers
List<Apipolicy
Api Spec Info Server> - title String
- version String
- component
Schema stringCount - 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 stringCount - oas
Version string - path
Count string - servers
Apipolicy
Api Spec Info Server[] - title string
- version string
- component_
schema_ strcount - 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_ strcount - oas_
version str - path_
count str - servers
Sequence[Apipolicy
Api Spec Info Server] - title str
- version str
- component
Schema StringCount - 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 StringCount - oas
Version String - path
Count String - servers List<Property Map>
- title String
- version String
ApipolicyApiSpecInfoServer, ApipolicyApiSpecInfoServerArgs
- 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 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 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.
- 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.
ApipolicyConfigpbAttribute, ApipolicyConfigpbAttributeArgs
- created_
by string - version string
- created_
by str - version str
ApipolicyLabelMapping, ApipolicyLabelMappingArgs
- Api
Policy List<string>Actions - Label string
- Enabled string
- Api
Policy []stringActions - Label string
- Enabled string
- api_
policy_ list(string)actions - label string
- enabled string
- api
Policy List<String>Actions - label String
- enabled String
- api
Policy string[]Actions - label string
- enabled string
- api_
policy_ Sequence[str]actions - label str
- enabled str
- api
Policy List<String>Actions - label String
- enabled String
ApipolicyNonApiUrlLabel, ApipolicyNonApiUrlLabelArgs
ApipolicyOrphanApiClassificationSetting, ApipolicyOrphanApiClassificationSettingArgs
- Enabled string
- Inspection
Interval stringUnit - Inspection
Interval stringValue
- Enabled string
- Inspection
Interval stringUnit - Inspection
Interval stringValue
- enabled string
- inspection_
interval_ stringunit - inspection_
interval_ stringvalue
- enabled String
- inspection
Interval StringUnit - inspection
Interval StringValue
- enabled string
- inspection
Interval stringUnit - inspection
Interval stringValue
- enabled String
- inspection
Interval StringUnit - inspection
Interval StringValue
ApipolicyOrphanApiLabel, ApipolicyOrphanApiLabelArgs
ApipolicyRoutingInfo, ApipolicyRoutingInfoArgs
ApipolicyRoutingInfoRule, ApipolicyRoutingInfoRuleArgs
- Matches
List<Apipolicy
Routing Info Rule Match> - 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.
- Matches
[]Apipolicy
Routing Info Rule Match - 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.
- matches list(object)
- 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.
- matches
List<Apipolicy
Routing Info Rule Match> - 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.
- matches
Apipolicy
Routing Info Rule Match[] - 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.
- matches
Sequence[Apipolicy
Routing Info Rule Match] - 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.
- matches List<Property Map>
- 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.
ApipolicyRoutingInfoRuleMatch, ApipolicyRoutingInfoRuleMatchArgs
- Bot
Detection List<ApipolicyResults Routing Info Rule Match Bot Detection Result> - Client
Ips List<ApipolicyRouting Info Rule Match Client Ip> -
List<Apipolicy
Routing Info Rule Match Cookie> - Geo
Matches List<ApipolicyRouting Info Rule Match Geo Match> - Hdrs
List<Apipolicy
Routing Info Rule Match Hdr> - Host
Hdrs List<ApipolicyRouting Info Rule Match Host Hdr> - Ip
Reputation List<ApipolicyTypes Routing Info Rule Match Ip Reputation Type> - Labels
List<Apipolicy
Routing Info Rule Match Label> - Methods
List<Apipolicy
Routing Info Rule Match Method> - Paths
List<Apipolicy
Routing Info Rule Match Path> - Protocols
List<Apipolicy
Routing Info Rule Match Protocol> - Queries
List<Apipolicy
Routing Info Rule Match Query> - Source
Ips List<ApipolicyRouting Info Rule Match Source Ip> - Tls
Fingerprint List<ApipolicyMatches Routing Info Rule Match Tls Fingerprint Match> - Versions
List<Apipolicy
Routing Info Rule Match Version> - Vs
Ports List<ApipolicyRouting Info Rule Match Vs Port>
- Bot
Detection []ApipolicyResults Routing Info Rule Match Bot Detection Result - Client
Ips []ApipolicyRouting Info Rule Match Client Ip -
[]Apipolicy
Routing Info Rule Match Cookie - Geo
Matches []ApipolicyRouting Info Rule Match Geo Match - Hdrs
[]Apipolicy
Routing Info Rule Match Hdr - Host
Hdrs []ApipolicyRouting Info Rule Match Host Hdr - Ip
Reputation []ApipolicyTypes Routing Info Rule Match Ip Reputation Type - Labels
[]Apipolicy
Routing Info Rule Match Label - Methods
[]Apipolicy
Routing Info Rule Match Method - Paths
[]Apipolicy
Routing Info Rule Match Path - Protocols
[]Apipolicy
Routing Info Rule Match Protocol - Queries
[]Apipolicy
Routing Info Rule Match Query - Source
Ips []ApipolicyRouting Info Rule Match Source Ip - Tls
Fingerprint []ApipolicyMatches Routing Info Rule Match Tls Fingerprint Match - Versions
[]Apipolicy
Routing Info Rule Match Version - Vs
Ports []ApipolicyRouting Info Rule Match Vs Port
- bot_
detection_ list(object)results - client_
ips list(object) - list(object)
- geo_
matches list(object) - hdrs list(object)
- host_
hdrs list(object) - ip_
reputation_ list(object)types - labels list(object)
- methods list(object)
- paths list(object)
- protocols list(object)
- queries list(object)
- source_
ips list(object) - tls_
fingerprint_ list(object)matches - versions list(object)
- vs_
ports list(object)
- bot
Detection List<ApipolicyResults Routing Info Rule Match Bot Detection Result> - client
Ips List<ApipolicyRouting Info Rule Match Client Ip> -
List<Apipolicy
Routing Info Rule Match Cookie> - geo
Matches List<ApipolicyRouting Info Rule Match Geo Match> - hdrs
List<Apipolicy
Routing Info Rule Match Hdr> - host
Hdrs List<ApipolicyRouting Info Rule Match Host Hdr> - ip
Reputation List<ApipolicyTypes Routing Info Rule Match Ip Reputation Type> - labels
List<Apipolicy
Routing Info Rule Match Label> - methods
List<Apipolicy
Routing Info Rule Match Method> - paths
List<Apipolicy
Routing Info Rule Match Path> - protocols
List<Apipolicy
Routing Info Rule Match Protocol> - queries
List<Apipolicy
Routing Info Rule Match Query> - source
Ips List<ApipolicyRouting Info Rule Match Source Ip> - tls
Fingerprint List<ApipolicyMatches Routing Info Rule Match Tls Fingerprint Match> - versions
List<Apipolicy
Routing Info Rule Match Version> - vs
Ports List<ApipolicyRouting Info Rule Match Vs Port>
- bot
Detection ApipolicyResults Routing Info Rule Match Bot Detection Result[] - client
Ips ApipolicyRouting Info Rule Match Client Ip[] -
Apipolicy
Routing Info Rule Match Cookie[] - geo
Matches ApipolicyRouting Info Rule Match Geo Match[] - hdrs
Apipolicy
Routing Info Rule Match Hdr[] - host
Hdrs ApipolicyRouting Info Rule Match Host Hdr[] - ip
Reputation ApipolicyTypes Routing Info Rule Match Ip Reputation Type[] - labels
Apipolicy
Routing Info Rule Match Label[] - methods
Apipolicy
Routing Info Rule Match Method[] - paths
Apipolicy
Routing Info Rule Match Path[] - protocols
Apipolicy
Routing Info Rule Match Protocol[] - queries
Apipolicy
Routing Info Rule Match Query[] - source
Ips ApipolicyRouting Info Rule Match Source Ip[] - tls
Fingerprint ApipolicyMatches Routing Info Rule Match Tls Fingerprint Match[] - versions
Apipolicy
Routing Info Rule Match Version[] - vs
Ports ApipolicyRouting Info Rule Match Vs Port[]
- bot_
detection_ Sequence[Apipolicyresults Routing Info Rule Match Bot Detection Result] - client_
ips Sequence[ApipolicyRouting Info Rule Match Client Ip] -
Sequence[Apipolicy
Routing Info Rule Match Cookie] - geo_
matches Sequence[ApipolicyRouting Info Rule Match Geo Match] - hdrs
Sequence[Apipolicy
Routing Info Rule Match Hdr] - host_
hdrs Sequence[ApipolicyRouting Info Rule Match Host Hdr] - ip_
reputation_ Sequence[Apipolicytypes Routing Info Rule Match Ip Reputation Type] - labels
Sequence[Apipolicy
Routing Info Rule Match Label] - methods
Sequence[Apipolicy
Routing Info Rule Match Method] - paths
Sequence[Apipolicy
Routing Info Rule Match Path] - protocols
Sequence[Apipolicy
Routing Info Rule Match Protocol] - queries
Sequence[Apipolicy
Routing Info Rule Match Query] - source_
ips Sequence[ApipolicyRouting Info Rule Match Source Ip] - tls_
fingerprint_ Sequence[Apipolicymatches Routing Info Rule Match Tls Fingerprint Match] - versions
Sequence[Apipolicy
Routing Info Rule Match Version] - vs_
ports Sequence[ApipolicyRouting Info Rule Match Vs Port]
- bot
Detection List<Property Map>Results - client
Ips List<Property Map> - List<Property Map>
- geo
Matches List<Property Map> - hdrs List<Property Map>
- host
Hdrs List<Property Map> - ip
Reputation List<Property Map>Types - labels List<Property Map>
- methods List<Property Map>
- paths List<Property Map>
- protocols List<Property Map>
- queries List<Property Map>
- source
Ips List<Property Map> - tls
Fingerprint List<Property Map>Matches - versions List<Property Map>
- vs
Ports List<Property Map>
ApipolicyRoutingInfoRuleMatchBotDetectionResult, ApipolicyRoutingInfoRuleMatchBotDetectionResultArgs
ApipolicyRoutingInfoRuleMatchBotDetectionResultClassification, ApipolicyRoutingInfoRuleMatchBotDetectionResultClassificationArgs
- Type string
- User
Defined stringType
- Type string
- User
Defined stringType
- type string
- user_
defined_ stringtype
- type String
- user
Defined StringType
- type string
- user
Defined stringType
- type str
- user_
defined_ strtype
- type String
- user
Defined StringType
ApipolicyRoutingInfoRuleMatchClientIp, ApipolicyRoutingInfoRuleMatchClientIpArgs
- match_
criteria string - addrs list(object)
- group_
refs list(string) - prefixes list(object)
- ranges list(object)
ApipolicyRoutingInfoRuleMatchClientIpAddr, ApipolicyRoutingInfoRuleMatchClientIpAddrArgs
ApipolicyRoutingInfoRuleMatchClientIpPrefix, ApipolicyRoutingInfoRuleMatchClientIpPrefixArgs
- ip_
addrs list(object) - mask string
- ip
Addrs List<Property Map> - mask String
ApipolicyRoutingInfoRuleMatchClientIpPrefixIpAddr, ApipolicyRoutingInfoRuleMatchClientIpPrefixIpAddrArgs
ApipolicyRoutingInfoRuleMatchClientIpRange, ApipolicyRoutingInfoRuleMatchClientIpRangeArgs
ApipolicyRoutingInfoRuleMatchClientIpRangeBegin, ApipolicyRoutingInfoRuleMatchClientIpRangeBeginArgs
ApipolicyRoutingInfoRuleMatchClientIpRangeEnd, ApipolicyRoutingInfoRuleMatchClientIpRangeEndArgs
ApipolicyRoutingInfoRuleMatchCookie, ApipolicyRoutingInfoRuleMatchCookieArgs
- Match
Criteria 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.
- Match
Case string - Value string
- Match
Criteria 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.
- Match
Case string - Value string
- match_
criteria 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.
- match_
case string - value string
- match
Criteria 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.
- match
Case String - value String
- match
Criteria 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.
- match
Case string - value string
- match_
criteria 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.
- match_
case str - value str
- match
Criteria 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.
- match
Case String - value String
ApipolicyRoutingInfoRuleMatchGeoMatch, ApipolicyRoutingInfoRuleMatchGeoMatchArgs
- Attribute string
- Match
Operation string - Values List<string>
- Attribute string
- Match
Operation string - Values []string
- attribute string
- match_
operation string - values list(string)
- attribute String
- match
Operation String - values List<String>
- attribute string
- match
Operation string - values string[]
- attribute str
- match_
operation str - values Sequence[str]
- attribute String
- match
Operation String - values List<String>
ApipolicyRoutingInfoRuleMatchHdr, ApipolicyRoutingInfoRuleMatchHdrArgs
- Hdr string
- Match
Criteria string - Match
Case string - String
Group List<string>Refs - Values List<string>
- Hdr string
- Match
Criteria string - Match
Case string - String
Group []stringRefs - Values []string
- hdr string
- match_
criteria string - match_
case string - string_
group_ list(string)refs - values list(string)
- hdr String
- match
Criteria String - match
Case String - string
Group List<String>Refs - values List<String>
- hdr string
- match
Criteria string - match
Case string - string
Group string[]Refs - values string[]
- hdr str
- match_
criteria str - match_
case str - string_
group_ Sequence[str]refs - values Sequence[str]
- hdr String
- match
Criteria String - match
Case String - string
Group List<String>Refs - values List<String>
ApipolicyRoutingInfoRuleMatchHostHdr, ApipolicyRoutingInfoRuleMatchHostHdrArgs
- Match
Criteria string - Match
Case string - Values List<string>
- Match
Criteria string - Match
Case string - Values []string
- match_
criteria string - match_
case string - values list(string)
- match
Criteria String - match
Case String - values List<String>
- match
Criteria string - match
Case string - values string[]
- match_
criteria str - match_
case str - values Sequence[str]
- match
Criteria String - match
Case String - values List<String>
ApipolicyRoutingInfoRuleMatchIpReputationType, ApipolicyRoutingInfoRuleMatchIpReputationTypeArgs
- Match
Operation string - Reputation
Types List<string>
- Match
Operation string - Reputation
Types []string
- match_
operation string - reputation_
types list(string)
- match
Operation String - reputation
Types List<String>
- match
Operation string - reputation
Types string[]
- match_
operation str - reputation_
types Sequence[str]
- match
Operation String - reputation
Types List<String>
ApipolicyRoutingInfoRuleMatchLabel, ApipolicyRoutingInfoRuleMatchLabelArgs
- Values List<string>
- Match
Criteria string
- Values []string
- Match
Criteria string
- values list(string)
- match_
criteria string
- values List<String>
- match
Criteria String
- values string[]
- match
Criteria string
- values Sequence[str]
- match_
criteria str
- values List<String>
- match
Criteria String
ApipolicyRoutingInfoRuleMatchMethod, ApipolicyRoutingInfoRuleMatchMethodArgs
- Match
Criteria string - Methods List<string>
- Match
Criteria string - Methods []string
- match_
criteria string - methods list(string)
- match
Criteria String - methods List<String>
- match
Criteria string - methods string[]
- match_
criteria str - methods Sequence[str]
- match
Criteria String - methods List<String>
ApipolicyRoutingInfoRuleMatchPath, ApipolicyRoutingInfoRuleMatchPathArgs
- Match
Criteria string - Match
Case string - Match
Decoded stringString - Match
Strs List<string> - String
Group List<string>Refs
- Match
Criteria string - Match
Case string - Match
Decoded stringString - Match
Strs []string - String
Group []stringRefs
- match_
criteria string - match_
case string - match_
decoded_ stringstring - match_
strs list(string) - string_
group_ list(string)refs
- match
Criteria String - match
Case String - match
Decoded StringString - match
Strs List<String> - string
Group List<String>Refs
- match
Criteria string - match
Case string - match
Decoded stringString - match
Strs string[] - string
Group string[]Refs
- match_
criteria str - match_
case str - match_
decoded_ strstring - match_
strs Sequence[str] - string_
group_ Sequence[str]refs
- match
Criteria String - match
Case String - match
Decoded StringString - match
Strs List<String> - string
Group List<String>Refs
ApipolicyRoutingInfoRuleMatchProtocol, ApipolicyRoutingInfoRuleMatchProtocolArgs
- Match
Criteria string - Protocols string
- Match
Criteria string - Protocols string
- match_
criteria string - protocols string
- match
Criteria String - protocols String
- match
Criteria string - protocols string
- match_
criteria str - protocols str
- match
Criteria String - protocols String
ApipolicyRoutingInfoRuleMatchQuery, ApipolicyRoutingInfoRuleMatchQueryArgs
- Match
Criteria string - Match
Case string - Match
Decoded stringString - Match
Strs List<string> - String
Group List<string>Refs
- Match
Criteria string - Match
Case string - Match
Decoded stringString - Match
Strs []string - String
Group []stringRefs
- match_
criteria string - match_
case string - match_
decoded_ stringstring - match_
strs list(string) - string_
group_ list(string)refs
- match
Criteria String - match
Case String - match
Decoded StringString - match
Strs List<String> - string
Group List<String>Refs
- match
Criteria string - match
Case string - match
Decoded stringString - match
Strs string[] - string
Group string[]Refs
- match_
criteria str - match_
case str - match_
decoded_ strstring - match_
strs Sequence[str] - string_
group_ Sequence[str]refs
- match
Criteria String - match
Case String - match
Decoded StringString - match
Strs List<String> - string
Group List<String>Refs
ApipolicyRoutingInfoRuleMatchSourceIp, ApipolicyRoutingInfoRuleMatchSourceIpArgs
- match_
criteria string - addrs list(object)
- group_
refs list(string) - prefixes list(object)
- ranges list(object)
ApipolicyRoutingInfoRuleMatchSourceIpAddr, ApipolicyRoutingInfoRuleMatchSourceIpAddrArgs
ApipolicyRoutingInfoRuleMatchSourceIpPrefix, ApipolicyRoutingInfoRuleMatchSourceIpPrefixArgs
- ip_
addrs list(object) - mask string
- ip
Addrs List<Property Map> - mask String
ApipolicyRoutingInfoRuleMatchSourceIpPrefixIpAddr, ApipolicyRoutingInfoRuleMatchSourceIpPrefixIpAddrArgs
ApipolicyRoutingInfoRuleMatchSourceIpRange, ApipolicyRoutingInfoRuleMatchSourceIpRangeArgs
ApipolicyRoutingInfoRuleMatchSourceIpRangeBegin, ApipolicyRoutingInfoRuleMatchSourceIpRangeBeginArgs
ApipolicyRoutingInfoRuleMatchSourceIpRangeEnd, ApipolicyRoutingInfoRuleMatchSourceIpRangeEndArgs
ApipolicyRoutingInfoRuleMatchTlsFingerprintMatch, ApipolicyRoutingInfoRuleMatchTlsFingerprintMatchArgs
- Match
Operation string - Fingerprints List<string>
- String
Group List<string>Refs
- Match
Operation string - Fingerprints []string
- String
Group []stringRefs
- match_
operation string - fingerprints list(string)
- string_
group_ list(string)refs
- match
Operation String - fingerprints List<String>
- string
Group List<String>Refs
- match
Operation string - fingerprints string[]
- string
Group string[]Refs
- match_
operation str - fingerprints Sequence[str]
- string_
group_ Sequence[str]refs
- match
Operation String - fingerprints List<String>
- string
Group List<String>Refs
ApipolicyRoutingInfoRuleMatchVersion, ApipolicyRoutingInfoRuleMatchVersionArgs
- Match
Criteria string - Versions List<string>
- Match
Criteria string - Versions []string
- match_
criteria string - versions list(string)
- match
Criteria String - versions List<String>
- match
Criteria string - versions string[]
- match_
criteria str - versions Sequence[str]
- match
Criteria String - versions List<String>
ApipolicyRoutingInfoRuleMatchVsPort, ApipolicyRoutingInfoRuleMatchVsPortArgs
- Match
Criteria string - Ports List<double>
- Match
Criteria string - Ports []float64
- match_
criteria string - ports list(number)
- match
Criteria String - ports List<Double>
- match
Criteria string - ports number[]
- match_
criteria str - ports Sequence[float]
- match
Criteria String - ports List<Number>
ApipolicyServerInfo, ApipolicyServerInfoArgs
- path_
prefix string - servers list(object)
ApipolicyServerInfoServer, ApipolicyServerInfoServerArgs
- 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 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 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.
- 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.
ApipolicyShadowApiLabel, ApipolicyShadowApiLabelArgs
ApipolicyValidationSetting, ApipolicyValidationSettingArgs
- Failed
Validation stringHeader Parameter Action - Failed
Validation stringPath Parameter Action - Failed
Validation stringQuery Argument Action - Failed
Validation stringRequest Body Parameter Action - Missing
Mandatory stringHeader Parameter Action - Missing
Mandatory stringQuery Argument Action - Missing
Mandatory stringRequest Body Parameter Action - Request
Outside stringPath Prefix Action - Unexpected
Query stringArgument Action - Unexpected
Request stringBody Parameter Action - Unexpected
Request stringHeader Action - Unknown
Content stringType Action - Unknown
Http stringMethod Action - Unknown
Path stringAction - Unknown
Response stringContent Type Action - Unknown
Response stringStatus Code Action
- Failed
Validation stringHeader Parameter Action - Failed
Validation stringPath Parameter Action - Failed
Validation stringQuery Argument Action - Failed
Validation stringRequest Body Parameter Action - Missing
Mandatory stringHeader Parameter Action - Missing
Mandatory stringQuery Argument Action - Missing
Mandatory stringRequest Body Parameter Action - Request
Outside stringPath Prefix Action - Unexpected
Query stringArgument Action - Unexpected
Request stringBody Parameter Action - Unexpected
Request stringHeader Action - Unknown
Content stringType Action - Unknown
Http stringMethod Action - Unknown
Path stringAction - Unknown
Response stringContent Type Action - Unknown
Response stringStatus Code Action
- failed_
validation_ stringheader_ parameter_ action - failed_
validation_ stringpath_ parameter_ action - failed_
validation_ stringquery_ argument_ action - failed_
validation_ stringrequest_ body_ parameter_ action - missing_
mandatory_ stringheader_ parameter_ action - missing_
mandatory_ stringquery_ argument_ action - missing_
mandatory_ stringrequest_ body_ parameter_ action - request_
outside_ stringpath_ prefix_ action - unexpected_
query_ stringargument_ action - unexpected_
request_ stringbody_ parameter_ action - unexpected_
request_ stringheader_ action - unknown_
content_ stringtype_ action - unknown_
http_ stringmethod_ action - unknown_
path_ stringaction - unknown_
response_ stringcontent_ type_ action - unknown_
response_ stringstatus_ code_ action
- failed
Validation StringHeader Parameter Action - failed
Validation StringPath Parameter Action - failed
Validation StringQuery Argument Action - failed
Validation StringRequest Body Parameter Action - missing
Mandatory StringHeader Parameter Action - missing
Mandatory StringQuery Argument Action - missing
Mandatory StringRequest Body Parameter Action - request
Outside StringPath Prefix Action - unexpected
Query StringArgument Action - unexpected
Request StringBody Parameter Action - unexpected
Request StringHeader Action - unknown
Content StringType Action - unknown
Http StringMethod Action - unknown
Path StringAction - unknown
Response StringContent Type Action - unknown
Response StringStatus Code Action
- failed
Validation stringHeader Parameter Action - failed
Validation stringPath Parameter Action - failed
Validation stringQuery Argument Action - failed
Validation stringRequest Body Parameter Action - missing
Mandatory stringHeader Parameter Action - missing
Mandatory stringQuery Argument Action - missing
Mandatory stringRequest Body Parameter Action - request
Outside stringPath Prefix Action - unexpected
Query stringArgument Action - unexpected
Request stringBody Parameter Action - unexpected
Request stringHeader Action - unknown
Content stringType Action - unknown
Http stringMethod Action - unknown
Path stringAction - unknown
Response stringContent Type Action - unknown
Response stringStatus Code Action
- failed_
validation_ strheader_ parameter_ action - failed_
validation_ strpath_ parameter_ action - failed_
validation_ strquery_ argument_ action - failed_
validation_ strrequest_ body_ parameter_ action - missing_
mandatory_ strheader_ parameter_ action - missing_
mandatory_ strquery_ argument_ action - missing_
mandatory_ strrequest_ body_ parameter_ action - request_
outside_ strpath_ prefix_ action - unexpected_
query_ strargument_ action - unexpected_
request_ strbody_ parameter_ action - unexpected_
request_ strheader_ action - unknown_
content_ strtype_ action - unknown_
http_ strmethod_ action - unknown_
path_ straction - unknown_
response_ strcontent_ type_ action - unknown_
response_ strstatus_ code_ action
- failed
Validation StringHeader Parameter Action - failed
Validation StringPath Parameter Action - failed
Validation StringQuery Argument Action - failed
Validation StringRequest Body Parameter Action - missing
Mandatory StringHeader Parameter Action - missing
Mandatory StringQuery Argument Action - missing
Mandatory StringRequest Body Parameter Action - request
Outside StringPath Prefix Action - unexpected
Query StringArgument Action - unexpected
Request StringBody Parameter Action - unexpected
Request StringHeader Action - unknown
Content StringType Action - unknown
Http StringMethod Action - unknown
Path StringAction - unknown
Response StringContent Type Action - unknown
Response StringStatus Code Action
ApipolicyZombieApiClassificationSetting, ApipolicyZombieApiClassificationSettingArgs
- Enabled string
- Inspection
Interval stringUnit - Inspection
Interval stringValue - Min
Percent string
- Enabled string
- Inspection
Interval stringUnit - Inspection
Interval stringValue - Min
Percent string
- enabled string
- inspection_
interval_ stringunit - inspection_
interval_ stringvalue - min_
percent string
- enabled String
- inspection
Interval StringUnit - inspection
Interval StringValue - min
Percent String
- enabled string
- inspection
Interval stringUnit - inspection
Interval stringValue - min
Percent string
- enabled String
- inspection
Interval StringUnit - inspection
Interval StringValue - min
Percent String
ApipolicyZombieApiLabel, ApipolicyZombieApiLabelArgs
Package Details
- Repository
- avi vmware/terraform-provider-avi
- License
- Notes
- This Pulumi package is based on the
aviTerraform Provider.
published on Friday, Oct 23, 2026 by vmware