Get Network Policy Set Stack (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/networkpolicysetstacks/:policy_set_id

List a specific network policy set stack of a tenant.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

policy_set_id stringrequired

The network policy set stack ID.

Responses

200

Successful Operation

application/json

Schema

Schema

default_policysetstack boolean

The default policy set stack.

defaultrule_policyset NetworkPolicySet

The default rule of the policy set.

clone_from string

The existing policy from Network Policies for cloning the policy set.

defaultrule_policyset boolean

The default rule for the policy set.

description

The description of the network policy set. Max size = 256.

disabled boolean

Lists if the network policy sets are disabled.

disabled_reason string

Reason the network policy set is disabled.

id string

The network policy set ID.

inactive boolean

Lists if the network policy set is inactive.

inactive_reason string

Reason the network policy set is inactive.

name stringrequired

The name of the network policy set.

policy_req_version string

The required version of the network policy.

policy_rules NetworkPolicyRule[]

Lists the details of the policy rules.

Array [

app_def_ids string[]

The app definition IDs that have applied network policy rules. The number of applications for a policy rule is limited to 256.

description

The description of the network policy rule. Max size = 256.

destination_prefixes_id string

The destination prefix ID.

enabled boolean

The network policy rule based on rules that are enabled.

id string

The network policy rule ID.

name stringrequired

The name of the network policy rule. Max size = 128.

network_context_id string

The network context applied to the network policy rule. Network context segments network traffic for the purpose of applying different network policy rules for the same application.

order_number integer

The network policy rule order number. The default order number for a policy rule is 1024.

paths_allowed PathsAllowedrequired

The paths allowed for the application.

active_paths WANPath[]required

The configured active path for the rule.

Array [

label string

The label to identify the path.

path_type stringrequired

Possible values: [vpn, direct, servicelink]

The path type.

]

backup_paths WANPath[]

The configured backup path for the rule.

Array [

label string

The label to identify the path.

path_type stringrequired

Possible values: [vpn, direct, servicelink]

The path type.

]

l3_failure_paths WANPath[]

The configured l3 failure path for the rule.

Array [

label string

The label to identify the path.

path_type stringrequired

Possible values: [vpn, direct, servicelink]

The path type.

]

service_context ServiceContext

Information on the service context.

active_service_label_id stringrequired

The configured active service label ID.

active_service_label_type string

Possible values: [CG_TRANSIT, NON_CG_TRANSIT, SASE]

The configured active service label type.

backup_service_label_id string

The configured backup service label ID.

backup_service_label_type string

Possible values: [CG_TRANSIT, NON_CG_TRANSIT, SASE]

The configured backup service label type.

type stringrequired

Possible values: [ALLOWED_TRANSIT, REQUIRED_TRANSIT]

The type of service context.

source_prefixes_id string

The ID of the source prefixes.

tags string[]

A information field that can be added to identify the network policy rule. Maximum 10 unique tags of length 1024 each are allowed.

]

region string

The region of the site.

send_to_element boolean

Send to element.

tags string[]

A information field that can be added to identify the network policy set. Maximum 10 unique tags of length 1024 each are allowed.

tenant_id stringrequired

The tenant ID.

defaultrule_policyset_id stringrequired

The default rule of the policy set ID.

description

The description of the network policy set stack. Max size = 256.

disabled boolean

Lists if the network policy set stacks are disabled.

disabled_reason string

Reason the network policy set stack is disabled.

id string

The network policy set stack ID.

inactive boolean

Lists if the network policy set stack is inactive.

inactive_reason string

Reason the network policy set stack is inactive.

legacy_policystack boolean

The legacy policy stack.

name stringrequired

The name of the policy set stack. Max size = 128.

policyset_ids string[]

The ID of the policy set.

policyset_ids_update boolean

Policyset Ids Update

policysets BasePolicySet[]
The details of the policy sets.
Array [
clone_from string
The existing policy from Network Policies for cloning the policy set.
description
The description of the network policy set. Max size = 256.
disabled boolean
Lists if the network policy sets are disabled.
disabled_reason string
Reason the network policy set is disabled.
id string
The network policy set ID.
inactive boolean
Lists if the network policy set is inactive.
inactive_reason string
Reason the network policy set is inactive.
name stringrequired
The name of the network policy set.
policy_rules BasePolicyRule[]
Lists the details of the policy rules.
Array [
description
The description of the policy rule. Max size = 256.
disabled boolean
Lists if the policy rules are disabled.
disabled_reason string
Reason the policy rule is disabled.
id string
The policy rule ID.
inactive boolean
Lists if the policy rule is inactive.
inactive_reason string
Reason the policy rule is inactive.
name stringrequired
The name of the policy rule.
policyset_id string
The ID of the policy set.
region string
The region of the site.
tags string[]
A information field that can be added to identify the policy rule. Maximum 10 unique tags of length 1024 each are allowed.
tenant_id stringrequired
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
]
region string
The region of the site.
send_to_element boolean
Send to element.
tags string[]
A information field that can be added to identify the network policy set. Maximum 10 unique tags of length 1024 each are allowed.
tenant_id stringrequired
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
]
region string

The region of the site.

tags string[]

A information field that can be added to identify the policy set stack. Maximum 10 unique tags of length 1024 each are allowed.

tenant_id stringrequired

The tenant ID.

Example (from schema)

{
  "default_policysetstack": true,
  "defaultrule_policyset": {
    "clone_from": "string",
    "defaultrule_policyset": true,
    "disabled": true,
    "disabled_reason": "string",
    "id": "string",
    "inactive": true,
    "inactive_reason": "string",
    "name": "string",
    "policy_req_version": "string",
    "policy_rules": [
      {
        "app_def_ids": [
          "string"
        ],
        "destination_prefixes_id": "string",
        "enabled": true,
        "id": "string",
        "name": "string",
        "network_context_id": "string",
        "order_number": 0,
        "paths_allowed": {
          "active_paths": [
            {
              "label": "string",
              "path_type": "vpn"
            }
          ],
          "backup_paths": [
            {
              "label": "string",
              "path_type": "vpn"
            }
          ],
          "l3_failure_paths": [
            {
              "label": "string",
              "path_type": "vpn"
            }
          ]
        },
        "service_context": {
          "active_service_label_id": "string",
          "active_service_label_type": "CG_TRANSIT",
          "backup_service_label_id": "string",
          "backup_service_label_type": "CG_TRANSIT",
          "type": "ALLOWED_TRANSIT"
        },
        "source_prefixes_id": "string",
        "tags": [
          "string"
        ]
      }
    ],
    "region": "string",
    "send_to_element": true,
    "tags": [
      "string"
    ],
    "tenant_id": "string"
  },
  "defaultrule_policyset_id": "string",
  "disabled": true,
  "disabled_reason": "string",
  "id": "string",
  "inactive": true,
  "inactive_reason": "string",
  "legacy_policystack": true,
  "name": "string",
  "policyset_ids": [
    "string"
  ],
  "policyset_ids_update": true,
  "policysets": [
    {
      "clone_from": "string",
      "disabled": true,
      "disabled_reason": "string",
      "id": "string",
      "inactive": true,
      "inactive_reason": "string",
      "name": "string",
      "policy_rules": [
        {
          "disabled": true,
          "disabled_reason": "string",
          "id": "string",
          "inactive": true,
          "inactive_reason": "string",
          "name": "string",
          "policyset_id": "string",
          "region": "string",
          "tags": [
            "string"
          ],
          "tenant_id": "string"
        }
      ],
      "region": "string",
      "send_to_element": true,
      "tags": [
        "string"
      ],
      "tenant_id": "string"
    }
  ],
  "region": "string",
  "tags": [
    "string"
  ],
  "tenant_id": "string"
}

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": "POLICYSETSTACK_CONFIG_DEFAULTRULE_POLICYSET_REQUIRED"
      },
      {
        "code": "INVALID_DEFAULTRULE_POLICYSET_ID_FORMAT"
      }
    ]
  }
}

Loading...