Contiv API documentation version v1
http://{serverfqdn}:10000/api/{version}
- serverfqdn: required (string)
- version: required (v1)
Auth API
Authentication/Authorization related API
get /auth_proxy/health
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- status: required (one of healthy, unhealthy)
- version: required (string)
- netmaster: required (object)
- status: required (one of healthy, unhealthy)
- reason: (string)
reason for netmaster being unhealthy
- version: (string)
omitted in case netmaster is unhealthy
Example:
{"netmaster":{"status":"healthy","version":"pv1.0.0-alpha-01-27-2017.23-16-47.UTC"},"status":"healthy","version":"1.0.0-alpha"}
+Login to Contiv API server
post /auth_proxy/login
Login to Contiv API server
Body
Media type: application/json
Type: object
Properties- username: required (string)
user name. If a local user doesn't exist by that name, AD authentication will be tried using sAMAccountName=username in BaseDN scope of the AD server (see ldap configuration for more details)
- password: required (string)
Example:
{
+ "username": "johndoe",
+ "password": "p@ssw0rd"
+}A collection of local_users
returns a list of local_user.
Add a new local_user.
get /auth_proxy/local_users
returns a list of local_user.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: array of local_user
Items: local_user
- username: required (string)
- password: required (string)
- firstname: (string)
Example:
John - lastname: (string)
Example:
Doe - disable: (boolean)
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
post /auth_proxy/local_users
Add a new local_user.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- username: required (string)
- password: required (string)
- firstname: (string)
Example:
John - lastname: (string)
Example:
Doe - disable: (boolean)
Example:
{
+ "username": "johndoe",
+ "password": "p@ssw0rd"
+}Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing local_user
returns local_user.
updates local_user.
deletes local_user.
get /auth_proxy/local_users/{username}
returns local_user.
A custom security scheme for authenticating requests.
URI Parameters
- username: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- username: required (string)
- password: required (string)
- firstname: (string)
Example:
John - lastname: (string)
Example:
Doe - disable: (boolean)
Example:
{
+ "username": "johndoe",
+ "password": "p@ssw0rd"
+}HTTP status code 404
Body
Media type: application/json
Type:
{"message": "local_user not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /auth_proxy/local_users/{username}
updates local_user.
A custom security scheme for authenticating requests.
URI Parameters
- username: required (string)
Body
Media type: application/json
Type: object
Properties- firstname: (string)
- lastname: (string)
- disable: (boolean)
- password: (string)
Example:
{
+ "firstname": "Jane",
+ "disable": true
+}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- username: required (string)
- password: required (string)
- firstname: (string)
Example:
John - lastname: (string)
Example:
Doe - disable: (boolean)
Example:
{
+ "username": "johndoe",
+ "password": "p@ssw0rd"
+}HTTP status code 404
Body
Media type: application/json
Type:
{"message": "local_user not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /auth_proxy/local_users/{username}
Entity representing ldap_configuration
updates/creates ldap_configuration
returns ldap_configuration.
updates ldap_configuration.
deletes ldap_configuration.
put /auth_proxy/ldap_configuration
updates/creates ldap_configuration
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- server: required (string)
FQDN or IP address of AD server
- port: required (integer - minimum: 0)
port where AD server is listening
- base_dn: required (string)
Distinguished name for base entity. All search queries will be scope to this BaseDN
- service_account_dn: required (string)
DN of the service account. auth_proxy will use this account to communicate with AD server. Hence this account must have appropriate privileges, specifically for lookup.
- service_account_password: required (string)
- start_tls: required (boolean)
switch session to TLS after proxy connects to AD server. This option must be configured on AD server. Recommended to set to true in production environments.
- insecure_skip_verify: required (boolean)
skip cert check on AD server. Recommended to set to false for production environments.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- server: required (string)
FQDN or IP address of AD server
Example:
auth.local.com - port: required (integer - minimum: 0)
port where AD server is listening
Example:
389 - base_dn: required (string)
Distinguished name for base entity. All search queries will be scope to this BaseDN
Example:
ou=eng,dc=auth,dc=com - service_account_dn: required (string)
DN of the service account. auth_proxy will use this account to communicate with AD server. Hence this account must have appropriate privileges, specifically for lookup.
- service_account_password: required (string)
- start_tls: required (boolean)
switch session to TLS after proxy connects to AD server. This option must be configured on AD server. Recommended to set to true in production environments.
- insecure_skip_verify: required (boolean)
skip cert check on AD server. Recommended to set to false for production environments.
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "ldap_configuration not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /auth_proxy/ldap_configuration
returns ldap_configuration.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- server: required (string)
FQDN or IP address of AD server
Example:
auth.local.com - port: required (integer - minimum: 0)
port where AD server is listening
Example:
389 - base_dn: required (string)
Distinguished name for base entity. All search queries will be scope to this BaseDN
Example:
ou=eng,dc=auth,dc=com - service_account_dn: required (string)
DN of the service account. auth_proxy will use this account to communicate with AD server. Hence this account must have appropriate privileges, specifically for lookup.
- service_account_password: required (string)
- start_tls: required (boolean)
switch session to TLS after proxy connects to AD server. This option must be configured on AD server. Recommended to set to true in production environments.
- insecure_skip_verify: required (boolean)
skip cert check on AD server. Recommended to set to false for production environments.
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "ldap_configuration not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /auth_proxy/ldap_configuration
updates ldap_configuration.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- server: required (string)
FQDN or IP address of AD server
- port: required (integer - minimum: 0)
port where AD server is listening
- base_dn: required (string)
Distinguished name for base entity. All search queries will be scope to this BaseDN
- service_account_dn: required (string)
DN of the service account. auth_proxy will use this account to communicate with AD server. Hence this account must have appropriate privileges, specifically for lookup.
- service_account_password: required (string)
- start_tls: required (boolean)
switch session to TLS after proxy connects to AD server. This option must be configured on AD server. Recommended to set to true in production environments.
- insecure_skip_verify: required (boolean)
skip cert check on AD server. Recommended to set to false for production environments.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- server: required (string)
FQDN or IP address of AD server
Example:
auth.local.com - port: required (integer - minimum: 0)
port where AD server is listening
Example:
389 - base_dn: required (string)
Distinguished name for base entity. All search queries will be scope to this BaseDN
Example:
ou=eng,dc=auth,dc=com - service_account_dn: required (string)
DN of the service account. auth_proxy will use this account to communicate with AD server. Hence this account must have appropriate privileges, specifically for lookup.
- service_account_password: required (string)
- start_tls: required (boolean)
switch session to TLS after proxy connects to AD server. This option must be configured on AD server. Recommended to set to true in production environments.
- insecure_skip_verify: required (boolean)
skip cert check on AD server. Recommended to set to false for production environments.
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "ldap_configuration not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
A collection of authorizations
returns a list of authorization.
Add a new authorization.
get /auth_proxy/authorizations
returns a list of authorization.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: array of authorization
Items: authorization
- principalName: required (string)
- local: required (boolean)
- role: required (string)
- tenantName: required (string)
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
post /auth_proxy/authorizations
Add a new authorization.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- principalName: required (string)
- local: required (boolean)
- role: required (string)
- tenantName: required (string)
Example:
{
+ "principalName": "johndoe",
+ "local": true,
+ "role": "ops",
+ "tenantName": "johnstenant"
+}Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing authorization
returns authorization.
deletes authorization.
get /auth_proxy/authorizations/{authzUUID}
returns authorization.
A custom security scheme for authenticating requests.
URI Parameters
- authzUUID: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- principalName: required (string)
- local: required (boolean)
- role: required (string)
- tenantName: required (string)
Example:
{
+ "principalName": "johndoe",
+ "local": true,
+ "role": "ops",
+ "tenantName": "johnstenant"
+}HTTP status code 404
Body
Media type: application/json
Type:
{"message": "authorization not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /auth_proxy/authorizations/{authzUUID}
deletes authorization.
A custom security scheme for authenticating requests.
URI Parameters
- authzUUID: required (string)
HTTP status code 204
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Inspect
Inspect APIs for various Contiv managed objects
Entity representing aciGw
returns aciGw.
get /inspect/aciGws/aciGw
returns aciGw.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- name: required (string - maxLength: 64 - pattern: ^(aciGw)$)
name of this block(must be 'aciGw')
- pathBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\])?$)
List of ACI fabric ports connected to cluster
- nodeBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})?$)
List of ACI complete nodes to be bound
- physicalDomain: required (string - maxLength: 128 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Name of the physical domain
- enforcePolicies: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Enforce security policy
- includeCommonTenant: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Include common tenant when searching for objects
- name: required (string - maxLength: 64 - pattern: ^(aciGw)$)
- Oper: required (object)
- numAppProfiles: required (integer)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "aciGw not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing appProfile
returns appProfile.
get /inspect/appProfiles/{appProfileName}
returns appProfile.
A custom security scheme for authenticating requests.
URI Parameters
- appProfileName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- appProfileName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Application Profile Name
- endpointGroups: required (array of items)
Member groups of the appProf
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "appProfile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing appProfile
returns appProfile.
get /inspect/appProfiles/{tenantName}
returns appProfile.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- appProfileName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Application Profile Name
- endpointGroups: required (array of items)
Member groups of the appProf
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "appProfile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing Bgp
returns Bgp.
get /inspect/Bgps/{hostname}
returns Bgp.
A custom security scheme for authenticating requests.
URI Parameters
- hostname: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- hostname: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
host name
- routerip: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Bgp router intf ip
- as: required (string - maxLength: 64)
AS id
- neighbor-as: required (string - maxLength: 64)
AS id
- neighbor: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Bgp neighbor
- hostname: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- Oper: required (object)
- numRoutes: required (integer)
number of routes
- neighborStatus: required (string)
neighbor status
- adminStatus: required (string)
admin status
- routes: required (array of items)
routes
- numRoutes: required (integer)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "Bgp not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing endpoint
returns endpoint.
get /inspect/endpoints/{endpointID}
returns endpoint.
A custom security scheme for authenticating requests.
URI Parameters
- endpointID: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- Oper: required (object)
- network: required (string)
- endpointID: required (string)
- serviceName: required (string)
- endpointGroupId: required (integer)
- endpointGroupKey: required (string)
- ipAddress: required (array of items)
- macAddress: required (string)
- homingHost: required (string)
- intfName: required (string)
- vtepIP: required (string)
- labels: required (string)
- containerID: required (string)
- containerName: required (string)
- virtualPort: required (string)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "endpoint not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing endpointGroup
returns endpointGroup.
get /inspect/endpointGroups/{tenantName}
returns endpointGroup.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- groupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- policies: required (array of items)
- extContractsGrps: required (array of items)
- netProfile: required (string)
- Oper: required (object)
- pktTag: required (integer)
internal packet tag
- externalPktTag: required (integer)
external packet tag
- numEndpoints: required (integer)
number of endpoints
- endpoints: required (array of endpoint)
endpoints in the group
Items: endpoint
- pktTag: required (integer)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "endpointGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing endpointGroup
returns endpointGroup.
get /inspect/endpointGroups/{groupName}
returns endpointGroup.
A custom security scheme for authenticating requests.
URI Parameters
- groupName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- groupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- policies: required (array of items)
- extContractsGrps: required (array of items)
- netProfile: required (string)
- Oper: required (object)
- pktTag: required (integer)
internal packet tag
- externalPktTag: required (integer)
external packet tag
- numEndpoints: required (integer)
number of endpoints
- endpoints: required (array of endpoint)
endpoints in the group
Items: endpoint
- pktTag: required (integer)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "endpointGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing extContractsGroup
returns extContractsGroup.
get /inspect/extContractsGroups/{tenantName}
returns extContractsGroup.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant name
- contractsGroupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Contracts group name
- contractsType: required (string)
Contracts type
- contracts: required (array of items)
Contracts list
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "extContractsGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing extContractsGroup
returns extContractsGroup.
get /inspect/extContractsGroups/{contractsGroupName}
returns extContractsGroup.
A custom security scheme for authenticating requests.
URI Parameters
- contractsGroupName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant name
- contractsGroupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Contracts group name
- contractsType: required (string)
Contracts type
- contracts: required (array of items)
Contracts list
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "extContractsGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing global
returns global.
get /inspect/globals/global
returns global.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- name: required (string - maxLength: 64 - pattern: ^(global)$)
name of this block(must be 'global')
- networkInfraType: required (string - maxLength: 64 - pattern: ^(aci|aci-opflex|default)?$)
Network infrastructure type
- vlans: required (string - pattern: ^([0-9]{1,4}?-[0-9]{1,4}?)$)
Allowed vlan range
- vxlans: required (string - pattern: ^([0-9]{1,8}?-[0-9]{1,8}?)$)
Allwed vxlan range
- fwdMode: required (string - maxLength: 64 - pattern: ^(bridge|routing)?$)
Forwarding Mode
- arpMode: required (string - maxLength: 64 - pattern: ^(proxy|flood)?$)
ARP Mode
- pvtSubnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})/16$)
Private Subnet used by host bridge
- name: required (string - maxLength: 64 - pattern: ^(global)$)
- Oper: required (object)
- numNetworks: required (integer)
- defaultNetwork: required (string)
- vlansInUse: required (string)
- vxlansInUse: required (string)
- freeVXLANsStart: required (integer)
- clusterMode: required (string)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "global not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing netprofile
returns netprofile.
get /inspect/netprofiles/{tenantName}
returns netprofile.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- profileName: required (string - maxLength: 64)
Network profile name
- tenantName: required (string)
Tenant name
- bandwidth: required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)
Allocated bandwidth
- DSCP: required (integer)
DSCP
- burst: required (integer)
burst size
- profileName: required (string - maxLength: 64)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "netprofile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing netprofile
returns netprofile.
get /inspect/netprofiles/{profileName}
returns netprofile.
A custom security scheme for authenticating requests.
URI Parameters
- profileName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- profileName: required (string - maxLength: 64)
Network profile name
- tenantName: required (string)
Tenant name
- bandwidth: required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)
Allocated bandwidth
- DSCP: required (integer)
DSCP
- burst: required (integer)
burst size
- profileName: required (string - maxLength: 64)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "netprofile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing network
returns network.
get /inspect/networks/{tenantName}
returns network.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
- pktTag: required (integer)
- Oper: required (object)
- pktTag: required (integer)
internal packet tag
- externalPktTag: required (integer)
external packet tag
- numEndpoints: required (integer)
external packet tag
- allocatedAddressesCount: required (integer)
Vlan/Vxlan Tag
- allocatedIPAddresses: required (string)
allocated IP addresses
- availableIPAddresses: required (string)
Available IP addresses
- endpoints: required (array of endpoint)
endpoints in the network
Items: endpoint
- pktTag: required (integer)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "network not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing network
returns network.
get /inspect/networks/{networkName}
returns network.
A custom security scheme for authenticating requests.
URI Parameters
- networkName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
- pktTag: required (integer)
- Oper: required (object)
- pktTag: required (integer)
internal packet tag
- externalPktTag: required (integer)
external packet tag
- numEndpoints: required (integer)
external packet tag
- allocatedAddressesCount: required (integer)
Vlan/Vxlan Tag
- allocatedIPAddresses: required (string)
allocated IP addresses
- availableIPAddresses: required (string)
Available IP addresses
- endpoints: required (array of endpoint)
endpoints in the network
Items: endpoint
- pktTag: required (integer)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "network not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing policy
returns policy.
get /inspect/policys/{tenantName}
returns policy.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- Oper: required (object)
- numEndpoints: required (integer)
number of endpoints
- policyViolations: required (integer)
number of policyViolations
- endpoints: required (array of endpoint)
endpoints associate with the policy
Items: endpoint
- numEndpoints: required (integer)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "policy not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing policy
returns policy.
get /inspect/policys/{policyName}
returns policy.
A custom security scheme for authenticating requests.
URI Parameters
- policyName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- Oper: required (object)
- numEndpoints: required (integer)
number of endpoints
- policyViolations: required (integer)
number of policyViolations
- endpoints: required (array of endpoint)
endpoints associate with the policy
Items: endpoint
- numEndpoints: required (integer)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "policy not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing rule
returns rule.
get /inspect/rules/{tenantName}
returns rule.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "rule not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing rule
returns rule.
get /inspect/rules/{policyName}
returns rule.
A custom security scheme for authenticating requests.
URI Parameters
- policyName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "rule not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing rule
returns rule.
get /inspect/rules/{ruleId}
returns rule.
A custom security scheme for authenticating requests.
URI Parameters
- ruleId: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "rule not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing serviceLB
returns serviceLB.
get /inspect/serviceLBs/{tenantName}
returns serviceLB.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Service network name
- serviceName: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
service name
- ipAddress: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Service ip
- selectors: required (array of items)
labels key value pair
- ports: required (array of items)
service provider port
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- Oper: required (object)
- serviceVip: required (string)
allocated IP addresses
- numProviders: required (integer)
number of provider endpoints for the service
- providers: required (array of endpoint)
provider endpoints for the service
Items: endpoint
- serviceVip: required (string)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "serviceLB not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing serviceLB
returns serviceLB.
get /inspect/serviceLBs/{serviceName}
returns serviceLB.
A custom security scheme for authenticating requests.
URI Parameters
- serviceName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Service network name
- serviceName: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
service name
- ipAddress: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Service ip
- selectors: required (array of items)
labels key value pair
- ports: required (array of items)
service provider port
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- Oper: required (object)
- serviceVip: required (string)
allocated IP addresses
- numProviders: required (integer)
number of provider endpoints for the service
- providers: required (array of endpoint)
provider endpoints for the service
Items: endpoint
- serviceVip: required (string)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "serviceLB not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing tenant
returns tenant.
get /inspect/tenants/{tenantName}
returns tenant.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- Config: required (object)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- defaultNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
Network name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- Oper: required (object)
- totalNetworks: required (integer)
total number of networks
- totalEPGs: required (integer)
total number of EPGs
- totalNetprofiles: required (integer)
total number of Netprofiles
- totalAppProfiles: required (integer)
total number of App-Profiles
- totalServicelbs: required (integer)
total number of Servicelbs
- totalPolicies: required (integer)
total number of totalPolicies
- totalEndpoints: required (integer)
total number of endpoints in the tenant
- endpoints: required (array of endpoint)
endpoints in the tenant
Items: endpoint
- networks: required (array of network)
networks in the tenant
Items: network
- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
- pktTag: required (integer)
- endpointGroups: required (array of endpointGroup)
endpointGroups in the tenant
Items: endpointGroup
- groupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- policies: required (array of items)
- extContractsGrps: required (array of items)
- netProfile: required (string)
- policies: required (array of policy)
policies in the tenant
Items: policy
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- servicelbs: required (array of serviceLB)
servicelbs in the tenant
Items: serviceLB
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Service network name
- serviceName: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
service name
- ipAddress: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Service ip
- selectors: required (array of items)
labels key value pair
- ports: required (array of items)
service provider port
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- totalNetworks: required (integer)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "tenant not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
ACI Gateways
ACI gateway settings
returns a list of aciGw.
Add a new aciGw.
get /aciGws
returns a list of aciGw.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: array of aciGw
Items: aciGw
- name: required (string - maxLength: 64 - pattern: ^(aciGw)$)
name of this block(must be 'aciGw')
- pathBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\])?$)
List of ACI fabric ports connected to cluster
- nodeBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})?$)
List of ACI complete nodes to be bound
- physicalDomain: required (string - maxLength: 128 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Name of the physical domain
- enforcePolicies: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Enforce security policy
- includeCommonTenant: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Include common tenant when searching for objects
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
post /aciGws
Add a new aciGw.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- name: required (string - maxLength: 64 - pattern: ^(aciGw)$)
name of this block(must be 'aciGw')
- pathBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\])?$)
List of ACI fabric ports connected to cluster
- nodeBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})?$)
List of ACI complete nodes to be bound
- physicalDomain: required (string - maxLength: 128 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Name of the physical domain
- enforcePolicies: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Enforce security policy
- includeCommonTenant: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Include common tenant when searching for objects
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing aciGw
updates/creates aciGw
returns aciGw.
updates aciGw.
deletes aciGw.
put /aciGws/aciGw
updates/creates aciGw
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- name: required (string - maxLength: 64 - pattern: ^(aciGw)$)
name of this block(must be 'aciGw')
- pathBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\])?$)
List of ACI fabric ports connected to cluster
- nodeBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})?$)
List of ACI complete nodes to be bound
- physicalDomain: required (string - maxLength: 128 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Name of the physical domain
- enforcePolicies: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Enforce security policy
- includeCommonTenant: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Include common tenant when searching for objects
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- name: required (string - maxLength: 64 - pattern: ^(aciGw)$)
name of this block(must be 'aciGw')
- pathBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\])?$)
List of ACI fabric ports connected to cluster
- nodeBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})?$)
List of ACI complete nodes to be bound
- physicalDomain: required (string - maxLength: 128 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Name of the physical domain
- enforcePolicies: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Enforce security policy
- includeCommonTenant: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Include common tenant when searching for objects
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "aciGw not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /aciGws/aciGw
returns aciGw.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- name: required (string - maxLength: 64 - pattern: ^(aciGw)$)
name of this block(must be 'aciGw')
- pathBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\])?$)
List of ACI fabric ports connected to cluster
- nodeBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})?$)
List of ACI complete nodes to be bound
- physicalDomain: required (string - maxLength: 128 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Name of the physical domain
- enforcePolicies: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Enforce security policy
- includeCommonTenant: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Include common tenant when searching for objects
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "aciGw not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /aciGws/aciGw
updates aciGw.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- name: required (string - maxLength: 64 - pattern: ^(aciGw)$)
name of this block(must be 'aciGw')
- pathBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\])?$)
List of ACI fabric ports connected to cluster
- nodeBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})?$)
List of ACI complete nodes to be bound
- physicalDomain: required (string - maxLength: 128 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Name of the physical domain
- enforcePolicies: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Enforce security policy
- includeCommonTenant: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Include common tenant when searching for objects
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- name: required (string - maxLength: 64 - pattern: ^(aciGw)$)
name of this block(must be 'aciGw')
- pathBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\[eth[0-9]{1,2}/[0-9]{1,2}\\])?$)
List of ACI fabric ports connected to cluster
- nodeBindings: required (string - maxLength: 2048 - pattern: ^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})?$)
List of ACI complete nodes to be bound
- physicalDomain: required (string - maxLength: 128 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Name of the physical domain
- enforcePolicies: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Enforce security policy
- includeCommonTenant: required (string - maxLength: 64 - pattern: ^(yes|no){1}$)
Include common tenant when searching for objects
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "aciGw not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Application Profiles
A collection of appProfiles
returns a list of appProfile.
Add a new appProfile.
get /appProfiles
returns a list of appProfile.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: array of appProfile
Items: appProfile
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- appProfileName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Application Profile Name
- endpointGroups: required (array of items)
Member groups of the appProf
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
post /appProfiles
Add a new appProfile.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- appProfileName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Application Profile Name
- endpointGroups: required (array of items)
Member groups of the appProf
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing appProfile
updates/creates appProfile
returns appProfile.
updates appProfile.
deletes appProfile.
put /appProfiles/{tenantName}
updates/creates appProfile
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: netmaster.appProfile
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- appProfileName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Application Profile Name
- endpointGroups: required (array of items)
Member groups of the appProf
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "appProfile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /appProfiles/{tenantName}
returns appProfile.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- appProfileName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Application Profile Name
- endpointGroups: required (array of items)
Member groups of the appProf
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "appProfile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /appProfiles/{tenantName}
updates appProfile.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: netmaster.appProfile
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- appProfileName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Application Profile Name
- endpointGroups: required (array of items)
Member groups of the appProf
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "appProfile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /appProfiles/{tenantName}
Entity representing appProfile
updates/creates appProfile
returns appProfile.
updates appProfile.
deletes appProfile.
put /appProfiles/{appProfileName}
updates/creates appProfile
A custom security scheme for authenticating requests.
URI Parameters
- appProfileName: required (string)
Body
Media type: application/json
Type: netmaster.appProfile
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- appProfileName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Application Profile Name
- endpointGroups: required (array of items)
Member groups of the appProf
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "appProfile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /appProfiles/{appProfileName}
returns appProfile.
A custom security scheme for authenticating requests.
URI Parameters
- appProfileName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- appProfileName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Application Profile Name
- endpointGroups: required (array of items)
Member groups of the appProf
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "appProfile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /appProfiles/{appProfileName}
updates appProfile.
A custom security scheme for authenticating requests.
URI Parameters
- appProfileName: required (string)
Body
Media type: application/json
Type: netmaster.appProfile
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- appProfileName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Application Profile Name
- endpointGroups: required (array of items)
Member groups of the appProf
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "appProfile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /appProfiles/{appProfileName}
deletes appProfile.
A custom security scheme for authenticating requests.
URI Parameters
- appProfileName: required (string)
HTTP status code 204
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
BGP
BGP settings
returns a list of Bgp.
Add a new Bgp.
get /Bgps
returns a list of Bgp.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: array of Bgp
Items: Bgp
- hostname: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
host name
- routerip: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Bgp router intf ip
- as: required (string - maxLength: 64)
AS id
- neighbor-as: required (string - maxLength: 64)
AS id
- neighbor: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Bgp neighbor
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
post /Bgps
Add a new Bgp.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- hostname: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
host name
- routerip: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Bgp router intf ip
- as: required (string - maxLength: 64)
AS id
- neighbor-as: required (string - maxLength: 64)
AS id
- neighbor: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Bgp neighbor
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing Bgp
updates/creates Bgp
returns Bgp.
updates Bgp.
deletes Bgp.
put /Bgps/{hostname}
updates/creates Bgp
A custom security scheme for authenticating requests.
URI Parameters
- hostname: required (string)
Body
Media type: application/json
Type: object
Properties- hostname: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
host name
- routerip: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Bgp router intf ip
- as: required (string - maxLength: 64)
AS id
- neighbor-as: required (string - maxLength: 64)
AS id
- neighbor: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Bgp neighbor
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- hostname: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
host name
- routerip: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Bgp router intf ip
- as: required (string - maxLength: 64)
AS id
- neighbor-as: required (string - maxLength: 64)
AS id
- neighbor: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Bgp neighbor
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "Bgp not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /Bgps/{hostname}
returns Bgp.
A custom security scheme for authenticating requests.
URI Parameters
- hostname: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- hostname: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
host name
- routerip: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Bgp router intf ip
- as: required (string - maxLength: 64)
AS id
- neighbor-as: required (string - maxLength: 64)
AS id
- neighbor: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Bgp neighbor
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "Bgp not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /Bgps/{hostname}
updates Bgp.
A custom security scheme for authenticating requests.
URI Parameters
- hostname: required (string)
Body
Media type: application/json
Type: object
Properties- hostname: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
host name
- routerip: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Bgp router intf ip
- as: required (string - maxLength: 64)
AS id
- neighbor-as: required (string - maxLength: 64)
AS id
- neighbor: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Bgp neighbor
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- hostname: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
host name
- routerip: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Bgp router intf ip
- as: required (string - maxLength: 64)
AS id
- neighbor-as: required (string - maxLength: 64)
AS id
- neighbor: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Bgp neighbor
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "Bgp not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /Bgps/{hostname}
Endpoint Groups
A collection of endpointGroups
returns a list of endpointGroup.
Add a new endpointGroup.
get /endpointGroups
returns a list of endpointGroup.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: array of endpointGroup
Items: endpointGroup
- groupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- policies: required (array of items)
- extContractsGrps: required (array of items)
- netProfile: required (string)
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
post /endpointGroups
Add a new endpointGroup.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- groupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- policies: required (array of items)
- extContractsGrps: required (array of items)
- netProfile: required (string)
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing endpointGroup
updates/creates endpointGroup
returns endpointGroup.
updates endpointGroup.
deletes endpointGroup.
put /endpointGroups/{tenantName}
updates/creates endpointGroup
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: netmaster.endpointGroup
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- groupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- policies: required (array of items)
- extContractsGrps: required (array of items)
- netProfile: required (string)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "endpointGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /endpointGroups/{tenantName}
returns endpointGroup.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- groupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- policies: required (array of items)
- extContractsGrps: required (array of items)
- netProfile: required (string)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "endpointGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /endpointGroups/{tenantName}
updates endpointGroup.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: netmaster.endpointGroup
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- groupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- policies: required (array of items)
- extContractsGrps: required (array of items)
- netProfile: required (string)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "endpointGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /endpointGroups/{tenantName}
deletes endpointGroup.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 204
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing endpointGroup
updates/creates endpointGroup
returns endpointGroup.
updates endpointGroup.
deletes endpointGroup.
put /endpointGroups/{groupName}
updates/creates endpointGroup
A custom security scheme for authenticating requests.
URI Parameters
- groupName: required (string)
Body
Media type: application/json
Type: netmaster.endpointGroup
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- groupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- policies: required (array of items)
- extContractsGrps: required (array of items)
- netProfile: required (string)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "endpointGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /endpointGroups/{groupName}
returns endpointGroup.
A custom security scheme for authenticating requests.
URI Parameters
- groupName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- groupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- policies: required (array of items)
- extContractsGrps: required (array of items)
- netProfile: required (string)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "endpointGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /endpointGroups/{groupName}
updates endpointGroup.
A custom security scheme for authenticating requests.
URI Parameters
- groupName: required (string)
Body
Media type: application/json
Type: netmaster.endpointGroup
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- groupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
- policies: required (array of items)
- extContractsGrps: required (array of items)
- netProfile: required (string)
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "endpointGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /endpointGroups/{groupName}
deletes endpointGroup.
A custom security scheme for authenticating requests.
URI Parameters
- groupName: required (string)
HTTP status code 204
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
External Contract Groups
A collection of extContractsGroups
returns a list of extContractsGroup.
Add a new extContractsGroup.
get /extContractsGroups
returns a list of extContractsGroup.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: array of extContractsGroup
Items: extContractsGroup
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant name
- contractsGroupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Contracts group name
- contractsType: required (string)
Contracts type
- contracts: required (array of items)
Contracts list
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
post /extContractsGroups
Add a new extContractsGroup.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant name
- contractsGroupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Contracts group name
- contractsType: required (string)
Contracts type
- contracts: required (array of items)
Contracts list
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing extContractsGroup
updates/creates extContractsGroup
returns extContractsGroup.
updates extContractsGroup.
deletes extContractsGroup.
put /extContractsGroups/{tenantName}
updates/creates extContractsGroup
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: netmaster.extContractsGroup
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant name
- contractsGroupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Contracts group name
- contractsType: required (string)
Contracts type
- contracts: required (array of items)
Contracts list
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "extContractsGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /extContractsGroups/{tenantName}
returns extContractsGroup.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant name
- contractsGroupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Contracts group name
- contractsType: required (string)
Contracts type
- contracts: required (array of items)
Contracts list
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "extContractsGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /extContractsGroups/{tenantName}
updates extContractsGroup.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: netmaster.extContractsGroup
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant name
- contractsGroupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Contracts group name
- contractsType: required (string)
Contracts type
- contracts: required (array of items)
Contracts list
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "extContractsGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /extContractsGroups/{tenantName}
deletes extContractsGroup.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 204
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing extContractsGroup
updates/creates extContractsGroup
returns extContractsGroup.
updates extContractsGroup.
deletes extContractsGroup.
put /extContractsGroups/{contractsGroupName}
updates/creates extContractsGroup
A custom security scheme for authenticating requests.
URI Parameters
- contractsGroupName: required (string)
Body
Media type: application/json
Type: netmaster.extContractsGroup
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant name
- contractsGroupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Contracts group name
- contractsType: required (string)
Contracts type
- contracts: required (array of items)
Contracts list
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "extContractsGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /extContractsGroups/{contractsGroupName}
returns extContractsGroup.
A custom security scheme for authenticating requests.
URI Parameters
- contractsGroupName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant name
- contractsGroupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Contracts group name
- contractsType: required (string)
Contracts type
- contracts: required (array of items)
Contracts list
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "extContractsGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /extContractsGroups/{contractsGroupName}
updates extContractsGroup.
A custom security scheme for authenticating requests.
URI Parameters
- contractsGroupName: required (string)
Body
Media type: application/json
Type: netmaster.extContractsGroup
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant name
- contractsGroupName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Contracts group name
- contractsType: required (string)
Contracts type
- contracts: required (array of items)
Contracts list
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "extContractsGroup not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /extContractsGroups/{contractsGroupName}
deletes extContractsGroup.
A custom security scheme for authenticating requests.
URI Parameters
- contractsGroupName: required (string)
HTTP status code 204
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Globals
Contiv global settings
returns a list of global.
Add a new global.
get /globals
returns a list of global.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: array of global
Items: global
- name: required (string - maxLength: 64 - pattern: ^(global)$)
name of this block(must be 'global')
- networkInfraType: required (string - maxLength: 64 - pattern: ^(aci|aci-opflex|default)?$)
Network infrastructure type
- vlans: required (string - pattern: ^([0-9]{1,4}?-[0-9]{1,4}?)$)
Allowed vlan range
- vxlans: required (string - pattern: ^([0-9]{1,8}?-[0-9]{1,8}?)$)
Allwed vxlan range
- fwdMode: required (string - maxLength: 64 - pattern: ^(bridge|routing)?$)
Forwarding Mode
- arpMode: required (string - maxLength: 64 - pattern: ^(proxy|flood)?$)
ARP Mode
- pvtSubnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})/16$)
Private Subnet used by host bridge
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
post /globals
Add a new global.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- name: required (string - maxLength: 64 - pattern: ^(global)$)
name of this block(must be 'global')
- networkInfraType: required (string - maxLength: 64 - pattern: ^(aci|aci-opflex|default)?$)
Network infrastructure type
- vlans: required (string - pattern: ^([0-9]{1,4}?-[0-9]{1,4}?)$)
Allowed vlan range
- vxlans: required (string - pattern: ^([0-9]{1,8}?-[0-9]{1,8}?)$)
Allwed vxlan range
- fwdMode: required (string - maxLength: 64 - pattern: ^(bridge|routing)?$)
Forwarding Mode
- arpMode: required (string - maxLength: 64 - pattern: ^(proxy|flood)?$)
ARP Mode
- pvtSubnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})/16$)
Private Subnet used by host bridge
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing global
updates/creates global
returns global.
updates global.
deletes global.
put /globals/global
updates/creates global
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- name: required (string - maxLength: 64 - pattern: ^(global)$)
name of this block(must be 'global')
- networkInfraType: required (string - maxLength: 64 - pattern: ^(aci|aci-opflex|default)?$)
Network infrastructure type
- vlans: required (string - pattern: ^([0-9]{1,4}?-[0-9]{1,4}?)$)
Allowed vlan range
- vxlans: required (string - pattern: ^([0-9]{1,8}?-[0-9]{1,8}?)$)
Allwed vxlan range
- fwdMode: required (string - maxLength: 64 - pattern: ^(bridge|routing)?$)
Forwarding Mode
- arpMode: required (string - maxLength: 64 - pattern: ^(proxy|flood)?$)
ARP Mode
- pvtSubnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})/16$)
Private Subnet used by host bridge
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- name: required (string - maxLength: 64 - pattern: ^(global)$)
name of this block(must be 'global')
- networkInfraType: required (string - maxLength: 64 - pattern: ^(aci|aci-opflex|default)?$)
Network infrastructure type
- vlans: required (string - pattern: ^([0-9]{1,4}?-[0-9]{1,4}?)$)
Allowed vlan range
- vxlans: required (string - pattern: ^([0-9]{1,8}?-[0-9]{1,8}?)$)
Allwed vxlan range
- fwdMode: required (string - maxLength: 64 - pattern: ^(bridge|routing)?$)
Forwarding Mode
- arpMode: required (string - maxLength: 64 - pattern: ^(proxy|flood)?$)
ARP Mode
- pvtSubnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})/16$)
Private Subnet used by host bridge
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "global not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /globals/global
returns global.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- name: required (string - maxLength: 64 - pattern: ^(global)$)
name of this block(must be 'global')
- networkInfraType: required (string - maxLength: 64 - pattern: ^(aci|aci-opflex|default)?$)
Network infrastructure type
- vlans: required (string - pattern: ^([0-9]{1,4}?-[0-9]{1,4}?)$)
Allowed vlan range
- vxlans: required (string - pattern: ^([0-9]{1,8}?-[0-9]{1,8}?)$)
Allwed vxlan range
- fwdMode: required (string - maxLength: 64 - pattern: ^(bridge|routing)?$)
Forwarding Mode
- arpMode: required (string - maxLength: 64 - pattern: ^(proxy|flood)?$)
ARP Mode
- pvtSubnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})/16$)
Private Subnet used by host bridge
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "global not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /globals/global
updates global.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- name: required (string - maxLength: 64 - pattern: ^(global)$)
name of this block(must be 'global')
- networkInfraType: required (string - maxLength: 64 - pattern: ^(aci|aci-opflex|default)?$)
Network infrastructure type
- vlans: required (string - pattern: ^([0-9]{1,4}?-[0-9]{1,4}?)$)
Allowed vlan range
- vxlans: required (string - pattern: ^([0-9]{1,8}?-[0-9]{1,8}?)$)
Allwed vxlan range
- fwdMode: required (string - maxLength: 64 - pattern: ^(bridge|routing)?$)
Forwarding Mode
- arpMode: required (string - maxLength: 64 - pattern: ^(proxy|flood)?$)
ARP Mode
- pvtSubnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})/16$)
Private Subnet used by host bridge
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- name: required (string - maxLength: 64 - pattern: ^(global)$)
name of this block(must be 'global')
- networkInfraType: required (string - maxLength: 64 - pattern: ^(aci|aci-opflex|default)?$)
Network infrastructure type
- vlans: required (string - pattern: ^([0-9]{1,4}?-[0-9]{1,4}?)$)
Allowed vlan range
- vxlans: required (string - pattern: ^([0-9]{1,8}?-[0-9]{1,8}?)$)
Allwed vxlan range
- fwdMode: required (string - maxLength: 64 - pattern: ^(bridge|routing)?$)
Forwarding Mode
- arpMode: required (string - maxLength: 64 - pattern: ^(proxy|flood)?$)
ARP Mode
- pvtSubnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})/16$)
Private Subnet used by host bridge
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "global not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Network Profiles
A collection of netprofiles
returns a list of netprofile.
Add a new netprofile.
get /netprofiles
returns a list of netprofile.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: array of netprofile
Items: netprofile
- profileName: required (string - maxLength: 64)
Network profile name
- tenantName: required (string)
Tenant name
- bandwidth: required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)
Allocated bandwidth
- DSCP: required (integer)
DSCP
- burst: required (integer)
burst size
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
post /netprofiles
Add a new netprofile.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- profileName: required (string - maxLength: 64)
Network profile name
- tenantName: required (string)
Tenant name
- bandwidth: required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)
Allocated bandwidth
- DSCP: required (integer)
DSCP
- burst: required (integer)
burst size
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing netprofile
updates/creates netprofile
returns netprofile.
updates netprofile.
deletes netprofile.
put /netprofiles/{tenantName}
updates/creates netprofile
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: object
Properties- profileName: required (string - maxLength: 64)
Network profile name
- tenantName: required (string)
Tenant name
- bandwidth: required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)
Allocated bandwidth
- DSCP: required (integer)
DSCP
- burst: required (integer)
burst size
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- profileName: required (string - maxLength: 64)
Network profile name
- tenantName: required (string)
Tenant name
- bandwidth: required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)
Allocated bandwidth
- DSCP: required (integer)
DSCP
- burst: required (integer)
burst size
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "netprofile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /netprofiles/{tenantName}
returns netprofile.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- profileName: required (string - maxLength: 64)
Network profile name
- tenantName: required (string)
Tenant name
- bandwidth: required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)
Allocated bandwidth
- DSCP: required (integer)
DSCP
- burst: required (integer)
burst size
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "netprofile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /netprofiles/{tenantName}
updates netprofile.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: object
Properties- profileName: required (string - maxLength: 64)
Network profile name
- tenantName: required (string)
Tenant name
- bandwidth: required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)
Allocated bandwidth
- DSCP: required (integer)
DSCP
- burst: required (integer)
burst size
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- profileName: required (string - maxLength: 64)
Network profile name
- tenantName: required (string)
Tenant name
- bandwidth: required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)
Allocated bandwidth
- DSCP: required (integer)
DSCP
- burst: required (integer)
burst size
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "netprofile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /netprofiles/{tenantName}
Entity representing netprofile
updates/creates netprofile
returns netprofile.
updates netprofile.
deletes netprofile.
put /netprofiles/{profileName}
updates/creates netprofile
A custom security scheme for authenticating requests.
URI Parameters
- profileName: required (string)
Body
Media type: application/json
Type: object
Properties- profileName: required (string - maxLength: 64)
Network profile name
- tenantName: required (string)
Tenant name
- bandwidth: required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)
Allocated bandwidth
- DSCP: required (integer)
DSCP
- burst: required (integer)
burst size
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- profileName: required (string - maxLength: 64)
Network profile name
- tenantName: required (string)
Tenant name
- bandwidth: required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)
Allocated bandwidth
- DSCP: required (integer)
DSCP
- burst: required (integer)
burst size
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "netprofile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /netprofiles/{profileName}
returns netprofile.
A custom security scheme for authenticating requests.
URI Parameters
- profileName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- profileName: required (string - maxLength: 64)
Network profile name
- tenantName: required (string)
Tenant name
- bandwidth: required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)
Allocated bandwidth
- DSCP: required (integer)
DSCP
- burst: required (integer)
burst size
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "netprofile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /netprofiles/{profileName}
updates netprofile.
A custom security scheme for authenticating requests.
URI Parameters
- profileName: required (string)
Body
Media type: application/json
Type: object
Properties- profileName: required (string - maxLength: 64)
Network profile name
- tenantName: required (string)
Tenant name
- bandwidth: required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)
Allocated bandwidth
- DSCP: required (integer)
DSCP
- burst: required (integer)
burst size
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- profileName: required (string - maxLength: 64)
Network profile name
- tenantName: required (string)
Tenant name
- bandwidth: required (string - maxLength: 64 - pattern: ^([1-9][0-9]* (([kmgKMG{1}]bps)|[kmgKMG{1}]|(kb|Kb|Gb|gb|Mb|mb)))?$|^([1-9][0-9]*(((k|m|g|K|G|M)bps)|(k|m|g|K|M|G)|(kb|Kb|Gb|gb|Mb|mb)))?$)
Allocated bandwidth
- DSCP: required (integer)
DSCP
- burst: required (integer)
burst size
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "netprofile not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /netprofiles/{profileName}
Networks
A collection of networks
returns a list of network.
Add a new network.
get /networks
returns a list of network.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: array of network
Items: network
- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
post /networks
Add a new network.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing network
updates/creates network
returns network.
updates network.
deletes network.
put /networks/{tenantName}
updates/creates network
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: object
Properties- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "network not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /networks/{tenantName}
returns network.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "network not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /networks/{tenantName}
updates network.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: object
Properties- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "network not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /networks/{tenantName}
Entity representing network
updates/creates network
returns network.
updates network.
deletes network.
put /networks/{networkName}
updates/creates network
A custom security scheme for authenticating requests.
URI Parameters
- networkName: required (string)
Body
Media type: application/json
Type: object
Properties- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "network not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /networks/{networkName}
returns network.
A custom security scheme for authenticating requests.
URI Parameters
- networkName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "network not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /networks/{networkName}
updates network.
A custom security scheme for authenticating requests.
URI Parameters
- networkName: required (string)
Body
Media type: application/json
Type: object
Properties- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- pktTag: required (integer)
Vlan/Vxlan Tag
- encap: required (string - pattern: ^(vlan|vxlan)$)
Encapsulation
- ipv6Gateway: required (string - pattern: ^(((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))?$)
IPv6Gateway
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- ipv6Subnet: required (string - pattern: ^((((([0-9]|[a-f]|[A-F]){1,4})((\\:([0-9]|[a-f]|[A-F]){1,4}){7}))|(((([0-9]|[a-f]|[A-F]){1,4}\\:){0,6}|\\:)((\\:([0-9]|[a-f]|[A-F]){1,4}){0,6}|\\:)))/(1[0-2][0-7]|[1-9][0-9]|[1-9]))?$)
IPv6Subnet
- gateway: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Gateway
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Network name
- subnet: required (string - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$)
Subnet
- nwType: required (string - pattern: ^(infra|data)$)
Network Type
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "network not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /networks/{networkName}
Policies
A collection of policys
returns a list of policy.
Add a new policy.
get /policys
returns a list of policy.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: array of policy
Items: policy
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
post /policys
Add a new policy.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing policy
updates/creates policy
returns policy.
updates policy.
deletes policy.
put /policys/{tenantName}
updates/creates policy
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: object
Properties- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "policy not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /policys/{tenantName}
returns policy.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "policy not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /policys/{tenantName}
updates policy.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: object
Properties- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "policy not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /policys/{tenantName}
Entity representing policy
updates/creates policy
returns policy.
updates policy.
deletes policy.
put /policys/{policyName}
updates/creates policy
A custom security scheme for authenticating requests.
URI Parameters
- policyName: required (string)
Body
Media type: application/json
Type: object
Properties- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "policy not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /policys/{policyName}
returns policy.
A custom security scheme for authenticating requests.
URI Parameters
- policyName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "policy not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /policys/{policyName}
updates policy.
A custom security scheme for authenticating requests.
URI Parameters
- policyName: required (string)
Body
Media type: application/json
Type: object
Properties- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "policy not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /policys/{policyName}
Rules
A collection of rules
returns a list of rule.
Add a new rule.
get /rules
returns a list of rule.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: array of rule
Items: rule
- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
post /rules
Add a new rule.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing rule
updates/creates rule
returns rule.
updates rule.
deletes rule.
put /rules/{tenantName}
updates/creates rule
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "rule not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /rules/{tenantName}
returns rule.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "rule not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /rules/{tenantName}
updates rule.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "rule not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /rules/{tenantName}
Entity representing rule
updates/creates rule
returns rule.
updates rule.
deletes rule.
put /rules/{policyName}
updates/creates rule
A custom security scheme for authenticating requests.
URI Parameters
- policyName: required (string)
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "rule not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /rules/{policyName}
returns rule.
A custom security scheme for authenticating requests.
URI Parameters
- policyName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "rule not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /rules/{policyName}
updates rule.
A custom security scheme for authenticating requests.
URI Parameters
- policyName: required (string)
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "rule not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /rules/{policyName}
Entity representing rule
updates/creates rule
returns rule.
updates rule.
deletes rule.
put /rules/{ruleId}
updates/creates rule
A custom security scheme for authenticating requests.
URI Parameters
- ruleId: required (string)
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "rule not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /rules/{ruleId}
returns rule.
A custom security scheme for authenticating requests.
URI Parameters
- ruleId: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "rule not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /rules/{ruleId}
updates rule.
A custom security scheme for authenticating requests.
URI Parameters
- ruleId: required (string)
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- protocol: required (string - pattern: ^(tcp|udp|icmp||[0-9]{1,3}?)$)
Protocol
- fromEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Endpoint Group
- fromIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- toEndpointGroup: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Endpoint Group
- toIpAddress: required (string - pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?(/(3[0-1]|2[0-9]|1[0-9]|[1-9]))?)?$)
IP Address
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- toNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
To Network
- port: required (integer)
Port No
- fromNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
From Network
- ruleId: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Rule Id
- priority: required (integer)
Priority
- action: required (string - pattern: ^(allow|deny)$)
Action
- direction: required (string - pattern: ^(in|out)$)
Direction
- policyName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Policy Name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "rule not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /rules/{ruleId}
Service Load Balancers
A collection of serviceLBs
returns a list of serviceLB.
Add a new serviceLB.
get /serviceLBs
returns a list of serviceLB.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: array of serviceLB
Items: serviceLB
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Service network name
- serviceName: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
service name
- ipAddress: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Service ip
- selectors: required (array of items)
labels key value pair
- ports: required (array of items)
service provider port
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
post /serviceLBs
Add a new serviceLB.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Service network name
- serviceName: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
service name
- ipAddress: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Service ip
- selectors: required (array of items)
labels key value pair
- ports: required (array of items)
service provider port
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing serviceLB
updates/creates serviceLB
returns serviceLB.
updates serviceLB.
deletes serviceLB.
put /serviceLBs/{tenantName}
updates/creates serviceLB
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: netmaster.serviceLB
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Service network name
- serviceName: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
service name
- ipAddress: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Service ip
- selectors: required (array of items)
labels key value pair
- ports: required (array of items)
service provider port
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "serviceLB not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /serviceLBs/{tenantName}
returns serviceLB.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Service network name
- serviceName: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
service name
- ipAddress: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Service ip
- selectors: required (array of items)
labels key value pair
- ports: required (array of items)
service provider port
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "serviceLB not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /serviceLBs/{tenantName}
updates serviceLB.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: netmaster.serviceLB
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Service network name
- serviceName: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
service name
- ipAddress: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Service ip
- selectors: required (array of items)
labels key value pair
- ports: required (array of items)
service provider port
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "serviceLB not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /serviceLBs/{tenantName}
Entity representing serviceLB
updates/creates serviceLB
returns serviceLB.
updates serviceLB.
deletes serviceLB.
put /serviceLBs/{serviceName}
updates/creates serviceLB
A custom security scheme for authenticating requests.
URI Parameters
- serviceName: required (string)
Body
Media type: application/json
Type: netmaster.serviceLB
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Service network name
- serviceName: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
service name
- ipAddress: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Service ip
- selectors: required (array of items)
labels key value pair
- ports: required (array of items)
service provider port
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "serviceLB not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /serviceLBs/{serviceName}
returns serviceLB.
A custom security scheme for authenticating requests.
URI Parameters
- serviceName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Service network name
- serviceName: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
service name
- ipAddress: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Service ip
- selectors: required (array of items)
labels key value pair
- ports: required (array of items)
service provider port
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "serviceLB not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /serviceLBs/{serviceName}
updates serviceLB.
A custom security scheme for authenticating requests.
URI Parameters
- serviceName: required (string)
Body
Media type: application/json
Type: netmaster.serviceLB
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- networkName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Service network name
- serviceName: required (string - maxLength: 256 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
service name
- ipAddress: required (string - maxLength: 15 - pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$)
Service ip
- selectors: required (array of items)
labels key value pair
- ports: required (array of items)
service provider port
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "serviceLB not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
delete /serviceLBs/{serviceName}
Tenants
A collection of tenants
returns a list of tenant.
Add a new tenant.
get /tenants
returns a list of tenant.
A custom security scheme for authenticating requests.
HTTP status code 200
Body
Media type: application/json
Type: array of tenant
Items: tenant
- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- defaultNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
Network name
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
post /tenants
Add a new tenant.
A custom security scheme for authenticating requests.
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- defaultNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
Network name
Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
Entity representing tenant
updates/creates tenant
returns tenant.
updates tenant.
deletes tenant.
put /tenants/{tenantName}
updates/creates tenant
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- defaultNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
Network name
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- defaultNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
Network name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "tenant not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
get /tenants/{tenantName}
returns tenant.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- defaultNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
Network name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "tenant not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.
patch /tenants/{tenantName}
updates tenant.
A custom security scheme for authenticating requests.
URI Parameters
- tenantName: required (string)
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- defaultNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
Network name
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tenantName: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$)
Tenant Name
- defaultNetwork: required (string - maxLength: 64 - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])?$)
Network name
HTTP status code 404
Body
Media type: application/json
Type:
{"message": "tenant not found" }
+Secured by custom_scheme
Headers
- X-Auth-Token: required (string)
Used to send a custom token. Obtained via /login API.