Create Application Definition Overrides for System Appdef (v2.2)

POST 
/v2.2/api/tenants/:tenant_id/appdefs/:appdef_id/overrides

Create an application definition overrides for system appdef.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

appdef_id stringrequired

Get the ID of the application definition.

application/json

Body

Application definition Override

aggregate_flows boolean

The aggregate flows.

app_unreachability_detection boolean

Application unreachability detection.

category string

Possible values: [anonymity, anti-virus, auth, backup, cad, collaboration, conference, crm, db-mgmt, email, enterprise, file-sharing, file-system, file-transfer, gaming, intercomm, logging, management, messaging, net-discovery, net-mgmt, net-monitor, news-server, notification, p2p, printing, proxy, recreational, remote-desk, remote-mgmt, replication, routing, saas, secure-browsing, storage, streaming, tunnel, utility, voip, wan-opt, web-browsing, wireless-mgmt, ip-protocol, multicast, security, i23v5, printer, default]

The application category.

conn_idle_timeout integer

Connection Idle Timeout. Application connection timeout should be in between 0-44000.

description

Description for the application. Max size = 256.

domains string[]

Applicable for layer 7 applications. List of application domains. Maximum 16 valid domains are allowed and each domain should not exceed 253 characters.

id string

Application ID.

ingress_traffic_pct integer

The app def config ingress traffic pct values. (Min value = 1, Max value = 99).

ip_rules IPRuleV2[]
Applicable for L3/L4 applications. These are IP Prefix rules used to identify the application viz protocol, dscp, source & destination prefixes and source & destination prefixes.
Array [
dest_filters string[]
The app def destination filter list. Max size = 8.
dest_prefixes string[]
The app def destination prefix filter list. Max size = 8.
dscp DSCP
The DSP value.
value int32
The DSCP value.
protocol stringrequired
Possible values: [ospf, ipv6, is-is-over-ipv4, ipv6-nonxt, etherip, ipv6-icmp, igmp, udplite, ipv6-opts, icmp, esp, crtp, ipip, eigrp, egp, gre, l2tpv3, sctp, ip-in-ip, rsvp, pim, scps, mpls-in-ip, ah, vrrp, ipv6-route, igp, ipv6-frag]
The app def protocols.
src_filters string[]
The app def src filters list. Max size = 8.
]
override_default_ip_rules boolean

The default override IP rules.

override_default_tcp_rules boolean

The default override TCP rules.

override_default_udp_rules boolean

The default override UDP rules.

override_domains boolean

List the override domains.

overrides_disable boolean

List the disabled overrides.

path_affinity string

Possible values: [none, weak, strict]

This parameter defines the path affinity characteristics to consider during flow decision making. Allowed values: "none" "weak" "strict". If path affinity is none or weak and a better path is available, flows will be moved to a new path. If path affinity is strict, all application flows will continue on the same path.

session_timeout integer

Application session timeout should be in between 0-44000.

tags string[]

A information field that can be added to identify the application. Maximum 10 Unique tags of length 1024 each are allowed.

tcp_rules TcpRuleV2[]
For TCP applications, this dictionary will include information on client & server prefix filters, server & client ports, DCSP settings.
Array [
client_filters string[]
The app def config IP list. Max size = 8.
client_port Port
The start and end client port ranges.
end string
The end port range must be between 1 and 65535.
start string
The start port range must be between 1 and 65535.
dscp DSCP
The DSP value.
value int32
The DSCP value.
server_filters string[]
The app def config IP list. Max size = 8.
server_port Port
The start and end server port ranges.
end string
The end port range must be between 1 and 65535.
start string
The start port range must be between 1 and 65535.
server_prefixes string[]
The server prefixes.
]
transfer_type string

Application transfer type. Allowed values: transactional, bulk, rt-audio, rt-video.

udp_rules UdpRuleV2[]
For UDP applications, this dictionary will include information on UDP port, DCSP settings, UDP Filters and destination prefixes.
Array [
dest_prefixes string[]
The app def destination prefix filter list. Max size = 8.
dscp DSCP
The DSP value.
value int32
The DSCP value.
udp_filters string[]
The app def config IP list. Max size = 8.
udp_port Port
The start and end UDP port ranges.
end string
The end port range must be between 1 and 65535.
start string
The start port range must be between 1 and 65535.
]
use_parentapp_network_policy boolean

If enabled, policy rule defined for the parent application will be used to make routing decisions for this app.

Responses

200

Successful Operation

application/json

Schema

Schema

aggregate_flows boolean

The aggregate flows.

app_unreachability_detection boolean

Application unreachability detection.

category string

Possible values: [anonymity, anti-virus, auth, backup, cad, collaboration, conference, crm, db-mgmt, email, enterprise, file-sharing, file-system, file-transfer, gaming, intercomm, logging, management, messaging, net-discovery, net-mgmt, net-monitor, news-server, notification, p2p, printing, proxy, recreational, remote-desk, remote-mgmt, replication, routing, saas, secure-browsing, storage, streaming, tunnel, utility, voip, wan-opt, web-browsing, wireless-mgmt, ip-protocol, multicast, security, i23v5, printer, default]

The application category.

conn_idle_timeout integer

Connection Idle Timeout. Application connection timeout should be in between 0-44000.

description

Description for the application. Max size = 256.

domains string[]

Applicable for layer 7 applications. List of application domains. Maximum 16 valid domains are allowed and each domain should not exceed 253 characters.

id string

Application ID.

ingress_traffic_pct integer

The app def ingress traffic. Application ingress traffic percentage should be in between 1-99.

ip_rules IPRuleV2[]
Applicable for L3/L4 applications. These are IP Prefix rules used to identify the application viz protocol, dscp, source & destination prefixes and source & destination prefixes.
Array [
dest_filters string[]
The app def destination filter list. Max size = 8.
dest_prefixes string[]
The app def destination prefix filter list. Max size = 8.
dscp DSCP
The DSP value.
value int32
The DSCP value.
protocol stringrequired
Possible values: [ospf, ipv6, is-is-over-ipv4, ipv6-nonxt, etherip, ipv6-icmp, igmp, udplite, ipv6-opts, icmp, esp, crtp, ipip, eigrp, egp, gre, l2tpv3, sctp, ip-in-ip, rsvp, pim, scps, mpls-in-ip, ah, vrrp, ipv6-route, igp, ipv6-frag]
The app def protocols.
src_filters string[]
The app def src filters list. Max size = 8.
]
override_default_ip_rules boolean

The default override IP rules.

override_default_tcp_rules boolean

The default override TCP rules.

override_default_udp_rules boolean

The default override UDP rules.

override_domains boolean

List the override domains.

overrides_disable boolean

List the disabled overrides.

path_affinity string

Possible values: [none, weak, strict]

This parameter defines the path affinity characteristics to consider during flow decision making. Allowed values: "none" "weak" "strict". If path affinity is none or weak and a better path is available, flows will be moved to a new path. If path affinity is strict, all application flows will continue on the same path.

session_timeout integer

Application session timeout should be in between 0-44000.

tags string[]

A information field that can be added to identify the application. Maximum 10 Unique tags of length 1024 each are allowed.

tcp_rules TcpRuleV2[]
For TCP applications, this dictionary will include information on client & server prefix filters, server & client ports, DCSP settings.
Array [
client_filters string[]
The app def config IP list. Max size = 8.
client_port Port
The start and end client port ranges.
end string
The end port range must be between 1 and 65535.
start string
The start port range must be between 1 and 65535.
dscp DSCP
The DSP value.
value int32
The DSCP value.
server_filters string[]
The app def config IP list. Max size = 8.
server_port Port
The start and end server port ranges.
end string
The end port range must be between 1 and 65535.
start string
The start port range must be between 1 and 65535.
server_prefixes string[]
The server prefixes.
]
transfer_type string

Application transfer type. Allowed values: transactional, bulk, rt-audio, rt-video.

udp_rules UdpRuleV2[]
For UDP applications, this dictionary will include information on UDP port, DCSP settings, UDP Filters and destination prefixes.
Array [
dest_prefixes string[]
The app def destination prefix filter list. Max size = 8.
dscp DSCP
The DSP value.
value int32
The DSCP value.
udp_filters string[]
The app def config IP list. Max size = 8.
udp_port Port
The start and end UDP port ranges.
end string
The end port range must be between 1 and 65535.
start string
The start port range must be between 1 and 65535.
]
use_parentapp_network_policy boolean

If enabled, policy rule defined for the parent application will be used to make routing decisions for this app.

Example (from schema)

{
  "aggregate_flows": true,
  "app_unreachability_detection": true,
  "category": "anonymity",
  "conn_idle_timeout": 0,
  "domains": [
    "string"
  ],
  "id": "string",
  "ingress_traffic_pct": 0,
  "ip_rules": [
    {
      "dest_filters": [
        "string"
      ],
      "dest_prefixes": [
        "string"
      ],
      "dscp": {
        "value": 0
      },
      "protocol": "ospf",
      "src_filters": [
        "string"
      ]
    }
  ],
  "override_default_ip_rules": true,
  "override_default_tcp_rules": true,
  "override_default_udp_rules": true,
  "override_domains": true,
  "overrides_disable": true,
  "path_affinity": "none",
  "session_timeout": 0,
  "tags": [
    "string"
  ],
  "tcp_rules": [
    {
      "client_filters": [
        "string"
      ],
      "client_port": {
        "end": "string",
        "start": "string"
      },
      "dscp": {
        "value": 0
      },
      "server_filters": [
        "string"
      ],
      "server_port": {
        "end": "string",
        "start": "string"
      },
      "server_prefixes": [
        "string"
      ]
    }
  ],
  "transfer_type": "string",
  "udp_rules": [
    {
      "dest_prefixes": [
        "string"
      ],
      "dscp": {
        "value": 0
      },
      "udp_filters": [
        "string"
      ],
      "udp_port": {
        "end": "string",
        "start": "string"
      }
    }
  ],
  "use_parentapp_network_policy": true
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "APPDEF_CONFIG_NO_SYSTEM_APPS"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_SYSTEM_APPS"
      },
      {
        "code": "APPDEF_CONFIG_APP_NOT_EXISTS"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_PROTOCOL"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_SESSION_TIMEOUT"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_RULE_CONFIG"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_DSCP"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_TIMEOUT"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_INGRESS"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_PATHAFFINITY"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_TRANSFER_TYPE"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_TCP_PORTS"
      },
      {
        "code": "APPDEF_CONFIG_DEPRECATED_APP"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_OVERRIDE_DOMAIN_FLAG"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_OVERRIDE_TCP_FLAG"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_OVERRIDE_UDP_FLAG"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_OVERRIDE_IP_FLAG"
      },
      {
        "code": "APPDEF_CONFIG_NOT_ALLOWED_V1"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_DOMAIN_RULE_CONFIG_V1"
      },
      {
        "code": "APPDEF_CONFIG_MISSING_UDP_PORTS"
      },
      {
        "code": "APPDEF_CONFIG_MISSING_TCP_PORTS"
      },
      {
        "code": "APPDEF_CONFIG_INVALID_UDP_PORTS"
      },
      {
        "code": "APPDEF_CONFIG_READ_ONLY_USE_PARENTAPP_NETWORK_POLICY"
      },
      {
        "code": "APPDEF_CONFIG_READ_ONLY_APP_UNREACHABILITY_DETECTION"
      }
    ]
  }
}

Loading...