{ "openapi": "3.0.0", "info": { "title": "Cisco Firepower Management Center Open API Specification", "description": "**Specifies the REST URLs and methods supported in the Cisco Firepower Management Center API. Refer to the version specific [REST API Quick Start Guide](https://www.cisco.com/c/en/us/support/security/defense-center/products-programming-reference-guides-list.html) for additional information.**", "contact": { "name": "Cisco Technical Assistance Center (TAC)", "url": "https://www.cisco.com/c/en/us/support/index.html", "email": "tac@cisco.com" }, "version": "1.0.0" }, "servers": [ { "url": "https://{defaultHost}", "variables": { "defaultHost": { "default": "www.example.com" } } } ], "paths": { "/api/fmc_config/v1/domain/{domainUUID}/devices/copyconfigrequests": { "post": { "tags": [ "Devices" ], "summary": "createDeviceCopyConfigRequest", "description": "**Copy configuration operation on device. _Check the response section for applicable examples (if any)._**", "operationId": "createDeviceCopyConfigRequest", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input for Copy configuration request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceCopyConfigRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceCopyConfigRequest" }, "example": { "sourceDevice": { "id": "device_uuid", "type": "Device" }, "targetDeviceList": [ { "id": "device_uuid", "type": "Device" } ], "copySharedPolicies": false } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords": { "get": { "tags": [ "Devices" ], "summary": "getAllDevice", "description": "**Retrieves or modifies the device record associated with the specified ID. Registers or unregisters a device. If no ID is specified for a GET, retrieves list of all device records.**", "operationId": "getAllDevice", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Devices" ], "summary": "createDevice", "description": "**Retrieves or modifies the device record associated with the specified ID. Registers or unregisters a device. If no ID is specified for a GET, retrieves list of all device records. _Check the response section for applicable examples (if any)._**", "operationId": "createDevice", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of device.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" }, "example": { "name": "", "hostName": "", "natID": "cisco123", "regKey": "regkey", "type": "Device", "license_caps": [ "MALWARE", "URLFilter", "PROTECT", "CONTROL", "VPN" ], "accessPolicy": { "id": "accessPolicyUUID", "type": "AccessPolicy" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/bridgegroupinterfaces": { "get": { "tags": [ "Devices" ], "summary": "getAllFTDBridgeGroupInterface", "description": "**Retrieves the bridge group interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all bridge group interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
**", "operationId": "getAllFTDBridgeGroupInterface", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDBridgeGroupInterfaceListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgegroupinterfaceUUID?offset=0&limit=2" }, "items": [ { "metadata": { "timestamp": 1462814174120, "domain": { "name": "Global", "id": "domainUUID" } }, "links": { "self": "/fmc_config/v1/domain/default/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgegroupinterfaceUUID1" }, "type": "BridgeGroupInterface", "selectedInterfaces": [ { "type": "PhysicalInterface", "name": "GigabitEthernet0/1", "id": "interface UUID" } ], "enabled": true, "MTU": 1500, "name": "BVI1", "ifname": "BVI1", "mode": "NONE", "managementOnly": false, "ipAddress": "1.2.3.4", "bridgeGroupId": 1, "ipv4": { "static": { "address": "1.2.3.4", "netmask": "25" } }, "id": "bridgegroupinterfaceUUID1" }, { "metadata": { "timestamp": 1462814174120, "domain": { "name": "Global", "id": "domainUUID" } }, "links": { "self": "/fmc_config/v1/domain/default/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgegroupinterfaceUUID2" }, "type": "BridgeGroupInterface", "selectedInterfaces": [ { "type": "PhysicalInterface", "name": "GigabitEthernet0/2", "id": "interface UUID" } ], "enabled": true, "MTU": 1500, "name": "BVI2", "ifname": "BVI2", "mode": "NONE", "managementOnly": false, "ipAddress": "1.2.3.4", "bridgeGroupId": 2, "ipv4": { "static": { "address": "1.2.3.4", "netmask": "25" } }, "id": "bridgegroupinterfaceUUID2" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Devices" ], "summary": "createFTDBridgeGroupInterface", "description": "**Retrieves the bridge group interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all bridge group interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
_Check the response section for applicable examples (if any)._**", "operationId": "createFTDBridgeGroupInterface", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input bridge group interface model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDBridgeGroupInterface" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDBridgeGroupInterface" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/bridgegroupinterfaces/{objectId}": { "get": { "tags": [ "Devices" ], "summary": "getFTDBridgeGroupInterface", "description": "**Retrieves the bridge group interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all bridge group interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
**", "operationId": "getFTDBridgeGroupInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a bridge group interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDBridgeGroupInterface" }, "example": { "type": "BridgeGroupInterface", "selectedInterfaces": [ { "type": "PhysicalInterface", "name": "GigabitEthernet0/1", "id": "interface UUID" } ], "enabled": true, "MTU": 1500, "ifname": "bridgeGroupIntf1", "managementOnly": false, "ipAddress": "1.2.3.4", "bridgeGroupId": 39, "ipv4": { "static": { "address": "1.2.3.4", "netmask": "25" } }, "id": "bridgegroupinterfaceUUID", "links": { "self": "/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgegroupinterfaceUUID" }, "metadata": { "readOnly": { "state": false }, "timestamp": 1458597038, "lastUser": { "name": "admin", "id": "UserUUID", "type": "user" }, "domain": { "name": "Global", "id": "DomainUUID", "type": "domain" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Devices" ], "summary": "updateFTDBridgeGroupInterface", "description": "**Retrieves the bridge group interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all bridge group interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
_Check the response section for applicable examples (if any)._**", "operationId": "updateFTDBridgeGroupInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a bridge group interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input bridge group interface model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDBridgeGroupInterface" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDBridgeGroupInterface" }, "example": { "id": "bridgeGroupIntfUUID", "type": "BridgeGroupInterface", "selectedInterfaces": [ { "type": "PhysicalInterface", "name": "GigabitEthernet0/0", "id": "interface UUID" } ], "enabled": true, "MTU": 1500, "ifname": "bridgeGroupIntf1", "managementOnly": false, "ipAddress": "1.2.3.5", "bridgeGroupId": 39, "ipv4": { "static": { "address": "1.2.3.5", "netmask": "25" } }, "ipv6": { "addresses": [ { "address": "9090::", "prefix": "12" } ], "dadAttempts": 1, "nsInterval": 10000, "reachableTime": 0 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Devices" ], "summary": "deleteFTDBridgeGroupInterface", "description": "**Retrieves the bridge group interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all bridge group interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
_Check the response section for applicable examples (if any)._**", "operationId": "deleteFTDBridgeGroupInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a bridge group interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDBridgeGroupInterface" }, "example": { "type": "BridgeGroupInterface", "selectedInterfaces": [ { "type": "PhysicalInterface", "name": "GigabitEthernet0/0", "id": "interface UUID" } ], "enabled": true, "MTU": 1500, "ifname": "bridgeGroupIntf1", "managementOnly": false, "ipAddress": "1.2.3.5", "bridgeGroupId": 39, "ipv4": { "static": { "address": "1.2.3.5", "netmask": "25" } }, "ipv6": { "addresses": [ { "address": "9090::", "prefix": "12" } ], "dadAttempts": 1, "nsInterval": 10000, "reachableTime": 0 }, "id": "bridgeGroupIntfUUID", "links": { "self": ":/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgeGroupIntfUUID" }, "metadata": { "timestamp": 0 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/etherchannelinterfaces": { "get": { "tags": [ "Devices" ], "summary": "getAllFTDEtherChannelInterface", "description": "**Retrieves the ethernet channel interface associated with the specified NGFW device ID and interface ID. If no ID is specified, retrieves list of all ethernet channel interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
**", "operationId": "getAllFTDEtherChannelInterface", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDEtherChannelInterfaceListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Devices" ], "summary": "createFTDEtherChannelInterface", "description": "**Retrieves the ethernet channel interface associated with the specified NGFW device ID and interface ID. If no ID is specified, retrieves list of all ethernet channel interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
_Check the response section for applicable examples (if any)._**", "operationId": "createFTDEtherChannelInterface", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input ethernet channel interface model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDEtherChannelInterface" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDEtherChannelInterface" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/etherchannelinterfaces/{objectId}": { "get": { "tags": [ "Devices" ], "summary": "getFTDEtherChannelInterface", "description": "**Retrieves the ethernet channel interface associated with the specified NGFW device ID and interface ID. If no ID is specified, retrieves list of all ethernet channel interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
**", "operationId": "getFTDEtherChannelInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a ethernet channel interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDEtherChannelInterface" }, "example": { "metadata": { "timestamp": 1462814173120, "domain": { "name": "Global", "id": "domainUUID" } }, "links": { "self": "/fmc_config/v1/domain/default/devices/devicerecords/containerUUID/etherchannelinterfaces/etherChannelIntfUUID1" }, "type": "EtherChannelInterface", "mode": "NONE", "lacpMode": "ACTIVE", "maxActivePhysicalInterface": 8, "minActivePhysicalInterface": 1, "selectedInterfaces": [ { "type": "PhysicalInterface", "name": "GigabitEthernet1/4", "id": "interface UUID" }, { "type": "PhysicalInterface", "name": "GigabitEthernet1/5", "id": "interface UUID" } ], "hardware": { "duplex": "AUTO", "speed": "AUTO" }, "loadBalancing": "SRC_IP_PORT", "etherChannelId": 1, "enabled": true, "MTU": 1500, "managementOnly": false, "securityZone": { "id": "securityZoneUUID", "type": "SecurityZone" }, "ifname": "NewEthChannel", "enableAntiSpoofing": false, "overrideDefaultFragmentSetting": {}, "ipv4": { "static": { "address": "10.20.25.10", "netmask": "24" } }, "ipv6": { "prefixes": [ { "advertisement": { "offlink": false, "autoConfig": true, "preferLifeTime": { "duration": { "preferLifeTime": 604800, "validLifeTime": 2592000 } } } } ], "enableAutoConfig": true, "enforceEUI64": true, "enableIPV6": true, "enableDHCPAddrConfig": true, "enableDHCPNonAddrConfig": true, "dadAttempts": 1, "nsInterval": 1000, "reachableTime": 13, "enableRA": true, "raLifeTime": 1800, "raInterval": 26, "addresses": [ { "address": "2002::/128", "enforceEUI64": true } ] }, "name": "Port-channel1", "id": "etherChannelIntfUUID1" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Devices" ], "summary": "updateFTDEtherChannelInterface", "description": "**Retrieves the ethernet channel interface associated with the specified NGFW device ID and interface ID. If no ID is specified, retrieves list of all ethernet channel interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
_Check the response section for applicable examples (if any)._**", "operationId": "updateFTDEtherChannelInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a ethernet channel interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input ethernet channel interface model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDEtherChannelInterface" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDEtherChannelInterface" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Devices" ], "summary": "deleteFTDEtherChannelInterface", "description": "**Retrieves the ethernet channel interface associated with the specified NGFW device ID and interface ID. If no ID is specified, retrieves list of all ethernet channel interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
_Check the response section for applicable examples (if any)._**", "operationId": "deleteFTDEtherChannelInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a ethernet channel interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDEtherChannelInterface" }, "example": { "type": "EtherChannelInterface", "mode": "NONE", "lacpMode": "ACTIVE", "maxActivePhysicalInterface": 8, "minActivePhysicalInterface": 1, "selectedInterfaces": [ { "type": "PhysicalInterface", "name": "GigabitEthernet0/0", "id": "interface UUID" } ], "hardware": { "duplex": "AUTO", "speed": "AUTO" }, "loadBalancing": "SRC_IP_PORT", "etherChannelId": 1, "enabled": true, "MTU": 1500, "managementOnly": false, "securityZone": { "id": "securityZoneUUID", "type": "SecurityZone" }, "ifname": "NewEthChannel", "enableAntiSpoofing": false, "overrideDefaultFragmentSetting": {}, "ipv4": { "static": { "address": "1.2.3.5", "netmask": "25" } }, "ipv6": { "addresses": [ { "address": "9090::", "prefix": "12" } ], "dadAttempts": 1, "nsInterval": 10000, "reachableTime": 0 }, "name": "Port-channel1", "id": "etherChannelIntfUUID1" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/fpinterfacestatistics": { "get": { "tags": [ "Devices" ], "summary": "getFPInterfaceStatistics", "description": "**Retrieves list of statistics for all interfaces associated with the specified NGIPS device ID.**", "operationId": "getFPInterfaceStatistics", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FPInterfaceStatisticsListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpinterfacestatistics?offset=0&limit=4" }, "items": [ { "name": "s1p1", "type": "FPInterfaceStatistics" }, { "name": "s1p2", "type": "FPInterfaceStatistics" }, { "name": "s1p3", "type": "FPInterfaceStatistics" }, { "name": "s1p4", "type": "FPInterfaceStatistics" } ], "paging": { "offset": 0, "limit": 4, "count": 4, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/fplogicalinterfaces": { "get": { "tags": [ "Devices" ], "summary": "getAllFPLogicalInterface", "description": "**Retrieves, deletes, creates, or modifies the logical interface associated with the specified NGIPS device ID and interface ID. If no ID is specified, retrieves list of all logical interfaces associated with the specified NGIPS device ID.**", "operationId": "getAllFPLogicalInterface", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FPLogicalInterfaceListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces?offset=0&limit=3" }, "items": [ { "name": "s1p3.1", "id": "1", "type": "FPLogicalInterface", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID1" } }, { "name": "s1p4.2", "id": "fplogicalinterfaceUUID2", "type": "FPLogicalInterface", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID2" } }, { "name": "hybrid_1", "id": "fplogicalinterfaceUUID3", "type": "FPLogicalInterface", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID3" } } ], "paging": { "offset": 0, "limit": 3, "count": 3, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Devices" ], "summary": "createFPLogicalInterface", "description": "**Retrieves, deletes, creates, or modifies the logical interface associated with the specified NGIPS device ID and interface ID. If no ID is specified, retrieves list of all logical interfaces associated with the specified NGIPS device ID. _Check the response section for applicable examples (if any)._**", "operationId": "createFPLogicalInterface", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input logical interface model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FPLogicalInterface" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FPLogicalInterface" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/fplogicalinterfaces/{objectId}": { "get": { "tags": [ "Devices" ], "summary": "getFPLogicalInterface", "description": "**Retrieves, deletes, creates, or modifies the logical interface associated with the specified NGIPS device ID and interface ID. If no ID is specified, retrieves list of all logical interfaces associated with the specified NGIPS device ID.**", "operationId": "getFPLogicalInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a logical interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FPLogicalInterface" }, "example": { "name": "s1p3.1", "id": "fplogicalinterfaceUUID", "type": "FPLogicalInterface", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID" }, "enabled": 1, "mdi": "auto", "mode": "autoneg", "interfaceType": "SWITCHED", "physicalInterface": { "name": "s1p3" }, "vlanTag": 1, "metadata": { "readOnly": { "state": false }, "timestamp": 1458597038, "lastUser": { "name": "admin", "id": "UserUUID", "type": "user" }, "domain": { "name": "Global", "id": "DomainUUID", "type": "domain" }, "activity": 0, "link": 0, "speed": -1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Devices" ], "summary": "updateFPLogicalInterface", "description": "**Retrieves, deletes, creates, or modifies the logical interface associated with the specified NGIPS device ID and interface ID. If no ID is specified, retrieves list of all logical interfaces associated with the specified NGIPS device ID. _Check the response section for applicable examples (if any)._**", "operationId": "updateFPLogicalInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a logical interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input logical interface model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FPLogicalInterface" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FPLogicalInterface" }, "example": { "name": "hybrid_1", "type": "FPLogicalInterface", "id": "fplogicalinterfaceUUID3", "enabled": 0, "ipAddresses": [ "10.1.1.2/18", "10.11.12.13/19" ], "interfaceType": "VLAN" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Devices" ], "summary": "deleteFPLogicalInterface", "description": "**Retrieves, deletes, creates, or modifies the logical interface associated with the specified NGIPS device ID and interface ID. If no ID is specified, retrieves list of all logical interfaces associated with the specified NGIPS device ID. _Check the response section for applicable examples (if any)._**", "operationId": "deleteFPLogicalInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a logical interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FPLogicalInterface" }, "example": { "name": "s1p3.1", "id": "fplogicalinterfaceUUID", "type": "FPLogicalInterface", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID" }, "enabled": 1, "mdi": "auto", "mode": "autoneg", "interfaceType": "SWITCHED", "physicalInterface": { "name": "s1p3" }, "vlanTag": 1, "metadata": { "readOnly": { "state": false }, "timestamp": 1458597038, "lastUser": { "name": "admin", "id": "UserUUID", "type": "user" }, "domain": { "name": "Global", "id": "DomainUUID", "type": "domain" }, "activity": 0, "link": 0, "speed": -1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/fpphysicalinterfaces": { "get": { "tags": [ "Devices" ], "summary": "getAllFPPhysicalInterface", "description": "**Retrieves, deletes, creates, or modifies the physical interface associated with the specified NGIPS device ID and interface ID. If no ID is specified, retrieves list of all physical interfaces associated with the specified NGIPS device ID.**", "operationId": "getAllFPPhysicalInterface", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FPPhysicalInterfaceListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces?offset=0&limit=4" }, "items": [ { "name": "s1p1", "id": "fpphysicalinterfaceUUID1", "type": "FPPhysicalInterface", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID1" } }, { "name": "s1p2", "id": "fpphysicalinterfaceUUID2", "type": "FPPhysicalInterface", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID2" } }, { "name": "s1p3", "id": "fpphysicalinterfaceUUID3", "type": "FPPhysicalInterface", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID3" } }, { "name": "s1p4", "id": "fpphysicalinterfaceUUID4", "type": "FPPhysicalInterface", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID4" } } ], "paging": { "offset": 0, "limit": 4, "count": 4, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/fpphysicalinterfaces/{objectId}": { "get": { "tags": [ "Devices" ], "summary": "getFPPhysicalInterface", "description": "**Retrieves, deletes, creates, or modifies the physical interface associated with the specified NGIPS device ID and interface ID. If no ID is specified, retrieves list of all physical interfaces associated with the specified NGIPS device ID.**", "operationId": "getFPPhysicalInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a physical interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FPPhysicalInterface" }, "example": { "name": "s1p1", "id": "fpphysicalinterfaceUUID1", "type": "FPPhysicalInterface", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID" }, "enabled": 1, "mdi": "auto", "mode": "autoneg", "interfaceType": "INLINE", "metadata": { "readOnly": { "state": true }, "timestamp": 1458595541, "lastUser": { "name": "admin", "id": "UserUUID", "type": "user" }, "domain": { "name": "TestDomain", "id": "DomainUUID", "type": "domain" }, "activity": 0, "link": 0, "speed": -1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Devices" ], "summary": "updateFPPhysicalInterface", "description": "**Retrieves, deletes, creates, or modifies the physical interface associated with the specified NGIPS device ID and interface ID. If no ID is specified, retrieves list of all physical interfaces associated with the specified NGIPS device ID. _Check the response section for applicable examples (if any)._**", "operationId": "updateFPPhysicalInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a physical interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input physical interface model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FPPhysicalInterface" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FPPhysicalInterface" }, "example": { "name": "s1p4", "type": "FPPhysicalInterface", "id": "fpphysicalinterfaceUUID2", "enabled": 1, "interfaceType": "INLINE" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/inlinesets": { "get": { "tags": [ "Devices" ], "summary": "getAllInlineSet", "description": "**Retrieves, deletes, creates, or modifies the inline set associated with the specified NGIPS device ID and inline set ID. If no inline set ID is specified, retrieves list of all inline sets associated with the specified NGIPS device ID.**", "operationId": "getAllInlineSet", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InlineSetListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets?offset=0&limit=1" }, "items": [ { "name": "Default Inline Set", "id": "inlinesetUUID", "type": "InlineSet", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets/inlinesetUUID" }, "failSafe": false, "failopen": true, "macFiltering": false, "inlinepairs": [ { "first": { "name": "s1p1", "type": "FPPhysicalInterface", "id": "FPPhysicalInterfaceUUID1" }, "second": { "name": "s1p2", "type": "FPPhysicalInterface", "id": "FPPhysicalInterfaceUUID2" } } ], "loadBalancingMode": "inner", "loadBalancingModeVlan": "inner", "mtu": 1518, "propogateLinkState": false, "strictTCPEnforcement": false, "metadata": { "readOnly": { "state": false }, "timestamp": 1458595542, "lastUser": { "name": "admin", "id": "UserUUID", "type": "user" }, "domain": { "name": "Global", "id": "DomainUUID", "type": "domain" } } } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Devices" ], "summary": "createInlineSet", "description": "**Retrieves, deletes, creates, or modifies the inline set associated with the specified NGIPS device ID and inline set ID. If no inline set ID is specified, retrieves list of all inline sets associated with the specified NGIPS device ID. _Check the response section for applicable examples (if any)._**", "operationId": "createInlineSet", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input inline set model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InlineSet" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InlineSet" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/inlinesets/{objectId}": { "get": { "tags": [ "Devices" ], "summary": "getInlineSet", "description": "**Retrieves, deletes, creates, or modifies the inline set associated with the specified NGIPS device ID and inline set ID. If no inline set ID is specified, retrieves list of all inline sets associated with the specified NGIPS device ID.**", "operationId": "getInlineSet", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of an inline set.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InlineSet" }, "example": { "name": "Default Inline Set", "id": "inlinesetUUID", "type": "InlineSet", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets/inlinesetUUID" }, "failSafe": false, "failopen": true, "macFiltering": false, "inlinepairs": [ { "first": { "name": "s1p1", "type": "FPPhysicalInterface", "id": "FPPhysicalInterfaceUUID1" }, "second": { "name": "s1p2", "type": "FPPhysicalInterface", "id": "FPPhysicalInterfaceUUID2" } } ], "loadBalancingMode": "inner", "loadBalancingModeVlan": "inner", "mtu": 1518, "propogateLinkState": false, "strictTCPEnforcement": false, "metadata": { "readOnly": { "state": false }, "timestamp": 1458595542, "lastUser": { "name": "admin", "id": "UserUUID", "type": "user" }, "domain": { "name": "Global", "id": "DomainUUID", "type": "domain" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Devices" ], "summary": "updateInlineSet", "description": "**Retrieves, deletes, creates, or modifies the inline set associated with the specified NGIPS device ID and inline set ID. If no inline set ID is specified, retrieves list of all inline sets associated with the specified NGIPS device ID. _Check the response section for applicable examples (if any)._**", "operationId": "updateInlineSet", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of an inline set.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input inline set model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InlineSet" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InlineSet" }, "example": { "name": "Default Inline Set", "id": "inlinesetUUID", "type": "InlineSet", "bypass": true, "standBy": true, "failSafe": true, "failopen": true, "macFiltering": false, "inlinepairs": [ { "first": { "name": "s1p1", "type": "FPPhysicalInterface", "id": "FPPhysicalInterfaceUUID1" }, "second": { "name": "s1p2", "type": "FPPhysicalInterface", "id": "FPPhysicalInterfaceUUID2" } } ], "loadBalancingMode": "inner", "loadBalancingModeVlan": "inner", "mtu": 1518, "propogateLinkState": true, "strictTCPEnforcement": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Devices" ], "summary": "deleteInlineSet", "description": "**Retrieves, deletes, creates, or modifies the inline set associated with the specified NGIPS device ID and inline set ID. If no inline set ID is specified, retrieves list of all inline sets associated with the specified NGIPS device ID. _Check the response section for applicable examples (if any)._**", "operationId": "deleteInlineSet", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of an inline set.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InlineSet" }, "example": { "name": "Default Inline Set", "id": "inlinesetUUID", "type": "InlineSet", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets/inlinesetUUID" }, "failSafe": false, "failopen": true, "macFiltering": false, "inlinepairs": [ { "first": { "name": "s1p1", "type": "FPPhysicalInterface", "id": "FPPhysicalInterfaceUUID1" }, "second": { "name": "s1p2", "type": "FPPhysicalInterface", "id": "FPPhysicalInterfaceUUID2" } } ], "loadBalancingMode": "inner", "loadBalancingModeVlan": "inner", "mtu": 1518, "propogateLinkState": false, "strictTCPEnforcement": false, "metadata": { "readOnly": { "state": false }, "timestamp": 1458595542, "lastUser": { "name": "admin", "id": "UserUUID", "type": "user" }, "domain": { "name": "Global", "id": "DomainUUID", "type": "domain" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/interfaceevents": { "get": { "tags": [ "Devices" ], "summary": "getInterfaceEvent", "description": "**Retrieves list of all netmod events on the device.**", "operationId": "getInterfaceEvent", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceEventListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Devices" ], "summary": "createInterfaceEvent", "description": "**Retrieves list of all netmod events on the device. _Check the response section for applicable examples (if any)._**", "operationId": "createInterfaceEvent", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input representing action to be performed on netmod events.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceEvent" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceEvent" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/physicalinterfaces": { "get": { "tags": [ "Devices" ], "summary": "getAllFTDPhysicalInterface", "description": "**Retrieves the physical interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all physical interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
**", "operationId": "getAllFTDPhysicalInterface", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDPhysicalInterfaceListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces?offset=0&limit=4" }, "items": [ { "metadata": { "timestamp": 1467048332483, "domain": { "name": "Global", "id": "Global_UUID" }, "_comment": "Supported speed will be available only for 2100 series devices", "supportedSpeed": "HUNDRED,TEN,THOUSAND,AUTO" }, "links": { "self": "/fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId1" }, "type": "PhysicalInterface", "mode": "INLINE", "hardware": { "duplex": "AUTO", "speed": "AUTO" }, "enabled": false, "MTU": 1500, "managementOnly": false, "securityZone": { "id": "SecZoneUUID1", "type": "SecurityZone" }, "ifname": "Intf1", "enableAntiSpoofing": false, "overrideDefaultFragmentSetting": {}, "ipv4": {}, "ipv6": {}, "name": "GigabitEthernet1/1", "id": "PhyIntfId1" }, { "metadata": { "timestamp": 1467048332483, "domain": { "name": "Global", "id": "Global_UUID" }, "_comment": "Supported speed will be available only for 2100 series devices", "supportedSpeed": "HUNDRED,TEN,THOUSAND,AUTO" }, "links": { "self": "/fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId2" }, "type": "PhysicalInterface", "mode": "INLINE", "hardware": { "duplex": "FULL", "speed": "THOUSAND" }, "enabled": false, "MTU": 1500, "managementOnly": false, "securityZone": { "id": "SecZoneUUID2", "type": "SecurityZone" }, "ifname": "Intf2", "enableAntiSpoofing": false, "overrideDefaultFragmentSetting": {}, "ipv4": {}, "ipv6": {}, "name": "GigabitEthernet1/2", "id": "PhyIntfId2" }, { "metadata": { "timestamp": 1467048332483, "domain": { "name": "Global", "id": "Global_UUID" }, "_comment": "Supported speed will be available only for 2100 series devices", "supportedSpeed": "HUNDRED,TEN,THOUSAND,AUTO" }, "links": { "self": "/fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId3" }, "type": "PhysicalInterface", "mode": "PASSIVE", "hardware": { "duplex": "AUTO", "speed": "AUTO" }, "enabled": true, "MTU": 1500, "managementOnly": false, "securityZone": { "id": "SecZoneUUID3", "type": "SecurityZone" }, "ifname": "PassiveIntf", "enableAntiSpoofing": false, "overrideDefaultFragmentSetting": {}, "ipv4": {}, "ipv6": {}, "name": "GigabitEthernet1/3", "id": "PhyIntfId3" }, { "metadata": { "timestamp": 1467048408466, "domain": { "name": "Global", "id": "Global_UUID" }, "_comment": "Supported speed will be available only for 2100 series devices", "supportedSpeed": "HUNDRED,TEN,THOUSAND,AUTO" }, "links": { "self": "/fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId4" }, "type": "PhysicalInterface", "mode": "ERSPAN", "isRedundantMember": false, "erspanSourceIP": "10.20.30.50", "erspanFlowId": 1, "hardware": { "duplex": "AUTO", "speed": "AUTO" }, "enabled": false, "MTU": 1500, "managementOnly": false, "securityZone": { "id": "SecZoneUUID4", "type": "SecurityZone" }, "ifname": "ErspanTest", "enableAntiSpoofing": false, "overrideDefaultFragmentSetting": {}, "ipv4": { "static": { "address": "10.20.30.40", "netmask": "24" } }, "ipv6": {}, "name": "GigabitEthernet1/4", "id": "PhyIntfId4" } ], "paging": { "offset": 0, "limit": 4, "count": 4, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/physicalinterfaces/{objectId}": { "get": { "tags": [ "Devices" ], "summary": "getFTDPhysicalInterface", "description": "**Retrieves the physical interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all physical interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
**", "operationId": "getFTDPhysicalInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a NGFW physical interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDPhysicalInterface" }, "example": { "metadata": { "timestamp": 1467048332483, "domain": { "name": "Global", "id": "Global_UUID" }, "_comment": "Supported speed will be available only for 2100 series devices", "supportedSpeed": "HUNDRED,TEN,THOUSAND,AUTO" }, "links": { "self": "/fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId1" }, "type": "PhysicalInterface", "mode": "INLINE", "hardware": { "duplex": "AUTO", "speed": "AUTO" }, "enabled": false, "MTU": 1500, "managementOnly": false, "securityZone": { "id": "SecZoneUUID1", "type": "SecurityZone" }, "ifname": "Intf1", "enableAntiSpoofing": false, "overrideDefaultFragmentSetting": {}, "ipv4": {}, "ipv6": {}, "name": "GigabitEthernet1/1", "id": "PhyIntfId1" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Devices" ], "summary": "updateFTDPhysicalInterface", "description": "**Retrieves the physical interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all physical interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
_Check the response section for applicable examples (if any)._**", "operationId": "updateFTDPhysicalInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a NGFW physical interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input NGFW physical interface model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDPhysicalInterface" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDPhysicalInterface" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/redundantinterfaces": { "get": { "tags": [ "Devices" ], "summary": "getAllFTDRedundantInterface", "description": "**Retrieves the redundant interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all redundant interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
**", "operationId": "getAllFTDRedundantInterface", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDRedundantInterfaceListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces?offset=0&limit=3" }, "items": [ { "name": "s1p3.1", "id": "1", "type": "RedundantInterface", "links": { "self": "/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID1" } }, { "name": "s1p4.2", "id": "redundantinterfaceUUID2", "type": "RedundantInterface", "links": { "self": "/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID2" } }, { "name": "hybrid_1", "id": "redundantinterfaceUUID3", "type": "RedundantInterface", "links": { "self": "/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID3" } } ], "paging": { "offset": 0, "limit": 3, "count": 3, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Devices" ], "summary": "createFTDRedundantInterface", "description": "**Retrieves the redundant interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all redundant interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
_Check the response section for applicable examples (if any)._**", "operationId": "createFTDRedundantInterface", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input redundant interface model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDRedundantInterface" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDRedundantInterface" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/redundantinterfaces/{objectId}": { "get": { "tags": [ "Devices" ], "summary": "getFTDRedundantInterface", "description": "**Retrieves the redundant interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all redundant interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
**", "operationId": "getFTDRedundantInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a redundant interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDRedundantInterface" }, "example": { "name": "Redundant4", "type": "RedundantInterface", "primaryInterface": { "name": "GigabitEthernet0/0", "type": "PhysicalInterface", "id": "interface UUID" }, "redundantId": 4, "secondaryInterface": { "name": "GigabitEthernet0/1", "type": "PhysicalInterface", "id": "interface UUID" }, "enabled": true, "MTU": 1500, "ifname": "redInter", "managementOnly": false, "ipv4": { "static": {} }, "ipv6": { "enforceEUI64": false, "enableAutoConfig": false, "enableDHCPAddrConfig": true, "enableDHCPNonAddrConfig": false, "dadAttempts": 1, "nsInterval": 1000, "reachableTime": 0, "enableRA": true, "raLifeTime": 1800, "raInterval": 200, "enableIPV6": false }, "enableAntiSpoofing": false, "overrideDefaultFragmentSetting": {}, "id": "00000000-0000-0ed3-0000-206158430258", "links": { "self": "/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID" }, "metadata": { "readOnly": { "state": false }, "timestamp": 1458597038, "lastUser": { "name": "admin", "id": "UserUUID", "type": "user" }, "domain": { "name": "Global", "id": "DomainUUID", "type": "domain" }, "activity": 0, "link": 0, "speed": -1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Devices" ], "summary": "updateFTDRedundantInterface", "description": "**Retrieves the redundant interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all redundant interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
_Check the response section for applicable examples (if any)._**", "operationId": "updateFTDRedundantInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a redundant interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input redundant interface model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDRedundantInterface" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDRedundantInterface" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Devices" ], "summary": "deleteFTDRedundantInterface", "description": "**Retrieves the redundant interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all redundant interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
_Check the response section for applicable examples (if any)._**", "operationId": "deleteFTDRedundantInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a redundant interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDRedundantInterface" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv4staticroutes": { "get": { "tags": [ "Devices" ], "summary": "getAllIPv4StaticRouteModel", "description": "**Retrieves, deletes, creates, or modifies the IPv4 Static Route associated with the specified ID. Also, retrieves list of all IPv4 Static routes. **", "operationId": "getAllIPv4StaticRouteModel", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPv4StaticRouteModelListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Devices" ], "summary": "createIPv4StaticRouteModel", "description": "**Retrieves, deletes, creates, or modifies the IPv4 Static Route associated with the specified ID. Also, retrieves list of all IPv4 Static routes. _Check the response section for applicable examples (if any)._**", "operationId": "createIPv4StaticRouteModel", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for IPv4 static routes.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input IPv4 Static Route model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPv4StaticRouteModel" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPv4StaticRouteModel" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv4staticroutes/{objectId}": { "get": { "tags": [ "Devices" ], "summary": "getIPv4StaticRouteModel", "description": "**Retrieves, deletes, creates, or modifies the IPv4 Static Route associated with the specified ID. Also, retrieves list of all IPv4 Static routes. **", "operationId": "getIPv4StaticRouteModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a IPv4 Static Route.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPv4StaticRouteModel" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Devices" ], "summary": "updateIPv4StaticRouteModel", "description": "**Retrieves, deletes, creates, or modifies the IPv4 Static Route associated with the specified ID. Also, retrieves list of all IPv4 Static routes. _Check the response section for applicable examples (if any)._**", "operationId": "updateIPv4StaticRouteModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a IPv4 Static Route.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input IPv4 Static Route model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPv4StaticRouteModel" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPv4StaticRouteModel" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Devices" ], "summary": "deleteIPv4StaticRouteModel", "description": "**Retrieves, deletes, creates, or modifies the IPv4 Static Route associated with the specified ID. Also, retrieves list of all IPv4 Static routes. _Check the response section for applicable examples (if any)._**", "operationId": "deleteIPv4StaticRouteModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a IPv4 Static Route.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPv4StaticRouteModel" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv6staticroutes": { "get": { "tags": [ "Devices" ], "summary": "getAllIPv6StaticRouteModel", "description": "**Retrieves, deletes, creates, or modifies the IPv6 Static Route associated with the specified ID. Also, retrieves list of all IPv6 Static routes. **", "operationId": "getAllIPv6StaticRouteModel", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPv6StaticRouteModelListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Devices" ], "summary": "createIPv6StaticRouteModel", "description": "**Retrieves, deletes, creates, or modifies the IPv6 Static Route associated with the specified ID. Also, retrieves list of all IPv6 Static routes. _Check the response section for applicable examples (if any)._**", "operationId": "createIPv6StaticRouteModel", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for IPv6 static routes.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input IPv6 Static Route model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPv6StaticRouteModel" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPv6StaticRouteModel" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv6staticroutes/{objectId}": { "get": { "tags": [ "Devices" ], "summary": "getIPv6StaticRouteModel", "description": "**Retrieves, deletes, creates, or modifies the IPv6 Static Route associated with the specified ID. Also, retrieves list of all IPv6 Static routes. **", "operationId": "getIPv6StaticRouteModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a IPv6 Static Route.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPv6StaticRouteModel" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid", "parent": "/api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes" }, "interfaceName": "InterfaceLogicalName", "selectedNetworks": [ { "type": "Network", "id": "networkObjUuid", "name": "any" } ], "gateway": { "literal": { "type": "Host", "value": "fe::" } }, "metricValue": 1, "isTunneled": false, "type": "IPv6StaticRoute", "id": "ipv6StaticRouteUuid" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Devices" ], "summary": "updateIPv6StaticRouteModel", "description": "**Retrieves, deletes, creates, or modifies the IPv6 Static Route associated with the specified ID. Also, retrieves list of all IPv6 Static routes. _Check the response section for applicable examples (if any)._**", "operationId": "updateIPv6StaticRouteModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a IPv6 Static Route.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input IPv6 Static Route model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPv6StaticRouteModel" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPv6StaticRouteModel" }, "example": { "interfaceName": "InterfaceLogicalName", "selectedNetworks": [ { "type": "Host", "id": "networkHostUuid", "name": "Host1" } ], "gateway": { "object": { "type": "Host", "id": "networkHostUuid", "name": "Host2" } }, "metricValue": 50, "type": "IPv6StaticRoute", "isTunneled": false, "id": "ipv6StaticRouteUuid" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Devices" ], "summary": "deleteIPv6StaticRouteModel", "description": "**Retrieves, deletes, creates, or modifies the IPv6 Static Route associated with the specified ID. Also, retrieves list of all IPv6 Static routes. _Check the response section for applicable examples (if any)._**", "operationId": "deleteIPv6StaticRouteModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a IPv6 Static Route.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPv6StaticRouteModel" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid", "parent": "/api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes" }, "interfaceName": "InterfaceLogicalName", "selectedNetworks": [ { "type": "Host", "id": "networkHostUuid", "name": "Host1" } ], "gateway": { "object": { "type": "Host", "id": "networkHostUuid", "name": "Host2" } }, "metricValue": 22, "type": "IPv6StaticRoute", "isTunneled": false, "id": "ipv6StaticRouteUuid" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/staticroutes": { "get": { "tags": [ "Devices" ], "summary": "getAllStaticRouteModel", "description": "**Retrieves list of all Static routes (ipv4 and ipv6) associated with the specified device.**", "operationId": "getAllStaticRouteModel", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaticRouteModelListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/staticroutes/{objectId}": { "get": { "tags": [ "Devices" ], "summary": "getStaticRouteModel", "description": "**Retrieves list of all Static routes (ipv4 and ipv6) associated with the specified device.**", "operationId": "getStaticRouteModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a Static Route", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaticRouteModel" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/subinterfaces": { "get": { "tags": [ "Devices" ], "summary": "getAllFTDSubInterface", "description": "**Retrieves the sub-interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all sub-interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
**", "operationId": "getAllFTDSubInterface", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDSubInterfaceListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/subinterfaces?offset=0&limit=2" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/subinterfaces/SubIntf1" }, "name": "GigabitEthernet1/4", "id": "SubIntf1" }, { "links": { "self": "/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/subinterfaces/SubIntf2" }, "name": "GigabitEthernet1/5", "id": "SubIntf2" } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Devices" ], "summary": "createFTDSubInterface", "description": "**Retrieves the sub-interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all sub-interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
_Check the response section for applicable examples (if any)._**", "operationId": "createFTDSubInterface", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for FTD sub interfaces.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input sub-interface model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDSubInterface" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDSubInterface" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/subinterfaces/{objectId}": { "get": { "tags": [ "Devices" ], "summary": "getFTDSubInterface", "description": "**Retrieves the sub-interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all sub-interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
**", "operationId": "getFTDSubInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a sub-interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDSubInterface" }, "example": { "metadata": { "timestamp": 1467055685450, "domain": { "name": "Global", "id": "GlobalDomainUUID" } }, "links": { "self": "/fmc_config/v1/domain/default/devices/devicerecords/containerUUID/subinterfaces/subinterfaceUUID" }, "type": "SubInterface", "vlanId": 2, "subIntfId": 25769804817, "enabled": true, "MTU": 1500, "ifname": "SubIntf2", "ipv4": { "static": {} }, "ipv6": { "prefixes": [ { "address": "2003::/128", "default": false, "advertisement": { "offlink": false, "autoConfig": true, "preferLifeTime": { "duration": { "preferLifeTime": 604800, "validLifeTime": 2592000 } } } } ], "enableIPV6": false, "linkLocalAddress": "FE80::19", "raLifeTime": 1800, "raInterval": 200, "addresses": [ { "address": "2002::", "prefix": "128", "enforceEUI64": false } ], "enableRA": true, "enforceEUI64": false, "enableAutoConfig": false, "enableDHCPAddrConfig": false, "enableDHCPNonAddrConfig": false, "dadAttempts": 1, "nsInterval": 1000, "reachableTime": 0 }, "managementOnly": false, "enableAntiSpoofing": false, "overrideDefaultFragmentSetting": { "size": 200, "timeout": 5, "chain": 24 }, "name": "GigabitEthernet1/4", "id": "subinterfaceUUID" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Devices" ], "summary": "updateFTDSubInterface", "description": "**Retrieves the sub-interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all sub-interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
_Check the response section for applicable examples (if any)._**", "operationId": "updateFTDSubInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a sub-interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input sub-interface model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDSubInterface" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDSubInterface" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Devices" ], "summary": "deleteFTDSubInterface", "description": "**Retrieves the sub-interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all sub-interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
_Check the response section for applicable examples (if any)._**", "operationId": "deleteFTDSubInterface", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a sub-interface.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDSubInterface" }, "example": { "metadata": { "timestamp": 1467055685450, "domain": { "name": "Global", "id": "GlobalDomainUUID" } }, "links": { "self": "/fmc_config/v1/domain/default/devices/devicerecords/containerUUID/subinterfaces/subinterfaceUUID" }, "type": "SubInterface", "vlanId": 2, "subIntfId": 25769804817, "enabled": true, "MTU": 1500, "ifname": "SubIntf2", "ipv4": { "static": {} }, "ipv6": { "prefixes": [ { "address": "2003::/128", "default": false, "advertisement": { "offlink": false, "autoConfig": true, "preferLifeTime": { "duration": { "preferLifeTime": 604800, "validLifeTime": 2592000 } } } } ], "enableIPV6": false, "linkLocalAddress": "FE80::19", "raLifeTime": 1800, "raInterval": 200, "addresses": [ { "address": "2002::", "prefix": "128", "enforceEUI64": false } ], "enableRA": true, "enforceEUI64": false, "enableAutoConfig": false, "enableDHCPAddrConfig": false, "enableDHCPNonAddrConfig": false, "dadAttempts": 1, "nsInterval": 1000, "reachableTime": 0 }, "managementOnly": false, "enableAntiSpoofing": false, "overrideDefaultFragmentSetting": { "size": 200, "timeout": 5, "chain": 24 }, "name": "GigabitEthernet0/1", "id": "subinterfaceUUID" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/virtualswitches": { "get": { "tags": [ "Devices" ], "summary": "getAllVirtualSwitch", "description": "**Retrieves, deletes, creates, or modifies the virtual switch associated with the specified NGIPS device ID and virtual switch ID. If no virtual switch ID is specified, retrieves list of all virtual switches associated with the specified NGIPS device ID.**", "operationId": "getAllVirtualSwitch", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualSwitchListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches?offset=0&limit=2" }, "items": [ { "name": "virtual_switch_1", "id": "virtualswitchUUID1", "type": "VirtualSwitch", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches/virtualswitchUUID1" }, "domainId": 2, "hybridInterface": { "name": "hybrid_1", "type": "FPLogicalInterface", "id": "hybridInterfaceUUID" }, "switchedInterfaces": [ { "name": "s1p3.1", "type": "FPLogicalInterface", "id": "switchedInterfaceUUID1" }, { "name": "s1p4.1", "type": "FPLogicalInterface", "id": "switchedInterfaceUUID2" } ], "dropBPDU": false, "enableSpanningTreeProtocol": false, "strictTCPEnforcement": false, "metadata": { "readOnly": { "state": false }, "timestamp": 1458595542, "lastUser": { "name": "admin", "id": "UserUUID", "type": "user" }, "domain": { "name": "Global", "id": "DomainUUID", "type": "domain" } } }, { "name": "virtual_switch_2", "id": "virtualswitchUUID2", "type": "VirtualSwitch", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches/virtualswitchUUID2" }, "domainId": 3, "dropBPDU": false, "enableSpanningTreeProtocol": true, "strictTCPEnforcement": false, "metadata": { "readOnly": { "state": false }, "timestamp": 1458595542, "lastUser": { "name": "admin", "id": "UserUUID", "type": "user" }, "domain": { "name": "Global", "id": "DomainUUID", "type": "domain" } } } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Devices" ], "summary": "createVirtualSwitch", "description": "**Retrieves, deletes, creates, or modifies the virtual switch associated with the specified NGIPS device ID and virtual switch ID. If no virtual switch ID is specified, retrieves list of all virtual switches associated with the specified NGIPS device ID. _Check the response section for applicable examples (if any)._**", "operationId": "createVirtualSwitch", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input virtual switch model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualSwitch" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualSwitch" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/virtualswitches/{objectId}": { "get": { "tags": [ "Devices" ], "summary": "getVirtualSwitch", "description": "**Retrieves, deletes, creates, or modifies the virtual switch associated with the specified NGIPS device ID and virtual switch ID. If no virtual switch ID is specified, retrieves list of all virtual switches associated with the specified NGIPS device ID.**", "operationId": "getVirtualSwitch", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a virtual switch.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualSwitch" }, "example": { "name": "virtual_switch_1", "id": "virtualswitchUUID1", "type": "VirtualSwitch", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches/virtualswitchUUID" }, "domainId": 2, "hybridInterface": { "name": "hybrid_1", "type": "FPLogicalInterface", "id": "hybridInterfaceUUID" }, "switchedInterfaces": [ { "name": "s1p3.1", "type": "FPLogicalInterface", "id": "switchedInterfaceUUID1" }, { "name": "s1p4.1", "type": "FPLogicalInterface", "id": "switchedInterfaceUUID2" } ], "dropBPDU": false, "enableSpanningTreeProtocol": false, "strictTCPEnforcement": false, "metadata": { "readOnly": { "state": false }, "timestamp": 1458595542, "lastUser": { "name": "admin", "id": "UserUUID", "type": "user" }, "domain": { "name": "Global", "id": "DomainUUID", "type": "domain" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Devices" ], "summary": "updateVirtualSwitch", "description": "**Retrieves, deletes, creates, or modifies the virtual switch associated with the specified NGIPS device ID and virtual switch ID. If no virtual switch ID is specified, retrieves list of all virtual switches associated with the specified NGIPS device ID. _Check the response section for applicable examples (if any)._**", "operationId": "updateVirtualSwitch", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a virtual switch.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input virtual switch model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualSwitch" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualSwitch" }, "example": { "name": "virtual_switch_2", "id": "virtualswitchUUID2", "type": "VirtualSwitch", "domainId": 3, "dropBPDU": true, "enableSpanningTreeProtocol": false, "strictTCPEnforcement": false, "hybridInterface": { "name": "hybrid_1", "type": "FPLogicalInterface", "id": "hybridInterfaceUUID" }, "switchedInterfaces": [ { "name": "s1p3.1", "type": "FPLogicalInterface", "id": "switchedInterfaceUUID1" }, { "name": "s1p4.1", "type": "FPLogicalInterface", "id": "switchedInterfaceUUID2" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Devices" ], "summary": "deleteVirtualSwitch", "description": "**Retrieves, deletes, creates, or modifies the virtual switch associated with the specified NGIPS device ID and virtual switch ID. If no virtual switch ID is specified, retrieves list of all virtual switches associated with the specified NGIPS device ID. _Check the response section for applicable examples (if any)._**", "operationId": "deleteVirtualSwitch", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a virtual switch.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualSwitch" }, "example": { "name": "virtual_switch_1", "id": "virtualswitchUUID1", "type": "VirtualSwitch", "links": { "self": "/fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches/virtualswitchUUID" }, "domainId": 2, "hybridInterface": { "name": "hybrid_1", "type": "FPLogicalInterface", "id": "hybridInterfaceUUID" }, "switchedInterfaces": [ { "name": "s1p3.1", "type": "FPLogicalInterface", "id": "switchedInterfaceUUID1" }, { "name": "s1p4.1", "type": "FPLogicalInterface", "id": "switchedInterfaceUUID2" } ], "dropBPDU": false, "enableSpanningTreeProtocol": false, "strictTCPEnforcement": false, "metadata": { "readOnly": { "state": false }, "timestamp": 1458595542, "lastUser": { "name": "admin", "id": "UserUUID", "type": "user" }, "domain": { "name": "Global", "id": "DomainUUID", "type": "domain" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{objectId}": { "get": { "tags": [ "Devices" ], "summary": "getDevice", "description": "**Retrieves or modifies the device record associated with the specified ID. Registers or unregisters a device. If no ID is specified for a GET, retrieves list of all device records.**", "operationId": "getDevice", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for a device.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Devices" ], "summary": "updateDevice", "description": "**Retrieves or modifies the device record associated with the specified ID. Registers or unregisters a device. If no ID is specified for a GET, retrieves list of all device records. _Check the response section for applicable examples (if any)._**", "operationId": "updateDevice", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for a device.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of device.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Devices" ], "summary": "deleteDevice", "description": "**Retrieves or modifies the device record associated with the specified ID. Registers or unregisters a device. If no ID is specified for a GET, retrieves list of all device records. _Check the response section for applicable examples (if any)._**", "operationId": "deleteDevice", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for a device.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/assignment/policyassignments": { "get": { "tags": [ "Policy Assignments" ], "summary": "getAllPolicyAssignment", "description": "**Retrieves, creates, or modifies the policy assignments to target devices associated with the specified ID. If no ID is specified, retrieves list of all policy assignments to target devices.**", "operationId": "getAllPolicyAssignment", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAssignmentListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/assignment/policyassignments/?offset=0&limit=2" }, "items": [ { "type": "PolicyAssignment", "id": "NatPolUuid", "name": "NATPOL" }, { "type": "PolicyAssignment", "id": "accessPolicyUuid", "name": "AccessPolicy1" } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Policy Assignments" ], "summary": "createPolicyAssignment", "description": "**Retrieves, creates, or modifies the policy assignments to target devices associated with the specified ID. If no ID is specified, retrieves list of all policy assignments to target devices. _Check the response section for applicable examples (if any)._**", "operationId": "createPolicyAssignment", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input policy assignment model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAssignment" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAssignment" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/assignment/policyassignments/{objectId}": { "get": { "tags": [ "Policy Assignments" ], "summary": "getPolicyAssignment", "description": "**Retrieves, creates, or modifies the policy assignments to target devices associated with the specified ID. If no ID is specified, retrieves list of all policy assignments to target devices.**", "operationId": "getPolicyAssignment", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a policy assignment.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAssignment" }, "example": { "id": "policyassignmentUUID", "type": "PolicyAssignment", "links": { "self": "/fmc_config/v1/domain/DomainUUID/assignment/policyassignments/policyassignmentUUID" }, "policy": { "type": "AccessPolicy", "description": "policy to test FMC implementation", "name": "AccessPolicy1", "id": "accesspolicyUUID" }, "targets": [ { "id": "deviceUUID", "type": "Device", "name": "FTD_Device1" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy Assignments" ], "summary": "updatePolicyAssignment", "description": "**Retrieves, creates, or modifies the policy assignments to target devices associated with the specified ID. If no ID is specified, retrieves list of all policy assignments to target devices. _Check the response section for applicable examples (if any)._**", "operationId": "updatePolicyAssignment", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a policy assignment.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input policy assignment model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAssignment" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAssignment" }, "example": { "type": "PolicyAssignment", "id": "policyassignmentUUID", "policy": { "type": "AccessPolicy", "name": "AccessPolicy1", "id": "accesspolicyUUID" }, "targets": [ { "id": "deviceUUID", "type": "Device", "name": "FTD_Device1" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs": { "get": { "tags": [ "Device HA Pairs" ], "summary": "getAllFTDHADeviceContainer", "description": "**Retrieves or modifies the FTD HA record associated with the specified ID. Creates or breaks or deletes a FTD HA pair. If no ID is specified for a GET, retrieves list of all FTD HA pairs.**", "operationId": "getAllFTDHADeviceContainer", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHADeviceContainerListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Device HA Pairs" ], "summary": "createFTDHADeviceContainer", "description": "**Retrieves or modifies the FTD HA record associated with the specified ID. Creates or breaks or deletes a FTD HA pair. If no ID is specified for a GET, retrieves list of all FTD HA pairs. _Check the response section for applicable examples (if any)._**", "operationId": "createFTDHADeviceContainer", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of FTD HA pair.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHADeviceContainer" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHADeviceContainer" }, "example": { "primary": { "id": "primary_uuid" }, "secondary": { "id": "secondary_uuid" }, "name": "", "type": "DeviceHAPair", "ftdHABootstrap": { "isEncryptionEnabled": false, "encKeyGenerationScheme": "CUSTOM", "sharedKey": "cisco123", "useSameLinkForFailovers": true, "lanFailover": { "useIPv6Address": false, "subnetMask": "255.255.255.0", "interfaceObject": { "id": "", "type": "PhysicalInterface", "name": "GigabitEthernet0/0" }, "standbyIP": "1.1.1.2", "logicalName": "LAN-INTERFACE", "activeIP": "1.1.1.1" }, "statefulFailover": { "useIPv6Address": true, "subnetMask": "255.255.255.0", "interfaceObject": { "id": "", "type": "PhysicalInterface", "name": "GigabitEthernet0/0" }, "standbyIP": "1.1.1.2", "logicalName": "STATEFUL-INTERFACE", "activeIP": "1.1.1.1" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{containerUUID}/failoverinterfacemacaddressconfigs": { "get": { "tags": [ "Device HA Pairs" ], "summary": "getAllFTDHAInterfaceMACAddresses", "description": "**Retrieves or modifies the FTD HA failover policy interface MAC addresses record associated with the specified FTD HA pair. If no ID is specified for a GET, retrieves list of all FTD HA failover policy interface MAC addresses records.**", "operationId": "getAllFTDHAInterfaceMACAddresses", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHAInterfaceMACAddressesListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Device HA Pairs" ], "summary": "createFTDHAInterfaceMACAddresses", "description": "**Retrieves or modifies the FTD HA failover policy interface MAC addresses record associated with the specified FTD HA pair. If no ID is specified for a GET, retrieves list of all FTD HA failover policy interface MAC addresses records. _Check the response section for applicable examples (if any)._**", "operationId": "createFTDHAInterfaceMACAddresses", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of FTD HA failover policy interface MAC addresses.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHAInterfaceMACAddresses" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHAInterfaceMACAddresses" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{containerUUID}/failoverinterfacemacaddressconfigs/{objectId}": { "get": { "tags": [ "Device HA Pairs" ], "summary": "getFTDHAInterfaceMACAddresses", "description": "**Retrieves or modifies the FTD HA failover policy interface MAC addresses record associated with the specified FTD HA pair. If no ID is specified for a GET, retrieves list of all FTD HA failover policy interface MAC addresses records.**", "operationId": "getFTDHAInterfaceMACAddresses", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier of a FTD HA failover policy interface MAC addresses.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHAInterfaceMACAddresses" }, "example": { "id": "", "type": "FailoverInterfaceMACAddressConfig", "physicalInterface": { "id": "", "type": "PhysicalInterface", "enabled": false, "MTU": 1500, "managementOnly": false, "name": "GigabitEthernet0/0" }, "failoverActiveMac": "0050.56a9.603c", "failoverStandbyMac": "0050.56a9.603d" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Device HA Pairs" ], "summary": "updateFTDHAInterfaceMACAddresses", "description": "**Retrieves or modifies the FTD HA failover policy interface MAC addresses record associated with the specified FTD HA pair. If no ID is specified for a GET, retrieves list of all FTD HA failover policy interface MAC addresses records. _Check the response section for applicable examples (if any)._**", "operationId": "updateFTDHAInterfaceMACAddresses", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier of a FTD HA failover policy interface MAC addresses.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of FTD HA failover policy interface MAC addresses.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHAInterfaceMACAddresses" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHAInterfaceMACAddresses" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Device HA Pairs" ], "summary": "deleteFTDHAInterfaceMACAddresses", "description": "**Retrieves or modifies the FTD HA failover policy interface MAC addresses record associated with the specified FTD HA pair. If no ID is specified for a GET, retrieves list of all FTD HA failover policy interface MAC addresses records. _Check the response section for applicable examples (if any)._**", "operationId": "deleteFTDHAInterfaceMACAddresses", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier of a FTD HA failover policy interface MAC addresses.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHAInterfaceMACAddresses" }, "example": { "id": "", "type": "FailoverInterfaceMACAddressConfig", "physicalInterface": { "id": "", "type": "PhysicalInterface", "enabled": false, "MTU": 1500, "managementOnly": false, "name": "GigabitEthernet0/0" }, "failoverActiveMac": "0050.56a9.603c", "failoverStandbyMac": "0050.56a9.603d" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{containerUUID}/monitoredinterfaces": { "get": { "tags": [ "Device HA Pairs" ], "summary": "getAllFTDHAMonitoredInterfaces", "description": "**Retrieves or modifies the FTD HA Monitored interface policy record associated with the specified FTD HA pair. If no ID is specified for a GET, retrieves list of all FTD HA monitored interface policy records.**", "operationId": "getAllFTDHAMonitoredInterfaces", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHAMonitoredInterfacesListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{containerUUID}/monitoredinterfaces/{objectId}": { "get": { "tags": [ "Device HA Pairs" ], "summary": "getFTDHAMonitoredInterfaces", "description": "**Retrieves or modifies the FTD HA Monitored interface policy record associated with the specified FTD HA pair. If no ID is specified for a GET, retrieves list of all FTD HA monitored interface policy records.**", "operationId": "getFTDHAMonitoredInterfaces", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier of a FTD HA Monitored interface policy.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHAMonitoredInterfaces" }, "example": { "id": "", "interfaceLogicalName": "", "ipv4Configuration": { "activeIPv4Address": "192.0.2.1", "activeIPv4Mask": "25", "standbyIPv4Address": "192.0.2.2" }, "ipv6Configuration": { "activeIPv6LinkLocalAddress": "FE80::C800:EFF:FE74:8", "standbyIPv6LinkLocalAddress": "FE80::C800:EFF:FE74:9", "ipv6ActiveStandbyPair": [ { "activeIPv6": "2006::/32", "standbyIPv6": "2006::/31" }, { "activeIPv6": "2005::/32", "standbyIPv6": "2005::/31" } ] }, "monitorForFailures": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Device HA Pairs" ], "summary": "updateFTDHAMonitoredInterfaces", "description": "**Retrieves or modifies the FTD HA Monitored interface policy record associated with the specified FTD HA pair. If no ID is specified for a GET, retrieves list of all FTD HA monitored interface policy records. _Check the response section for applicable examples (if any)._**", "operationId": "updateFTDHAMonitoredInterfaces", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier of a FTD HA Monitored interface policy.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of FTD HA Monitored interface policy.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHAMonitoredInterfaces" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHAMonitoredInterfaces" }, "example": { "id": "", "name": "", "ipv4Configuration": { "standbyIPv4Address": "192.0.2.2" }, "ipv6Configuration": { "standbyIPv6LinkLocalAddress": "FE80::C800:EFF:FE74:9", "ipv6ActiveStandbyPair": [ { "activeIPv6": "2006::/32", "standbyIPv6": "2006::31" }, { "activeIPv6": "2005::/32", "standbyIPv6": "2005::31" } ] }, "monitorForFailures": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{objectId}": { "get": { "tags": [ "Device HA Pairs" ], "summary": "getFTDHADeviceContainer", "description": "**Retrieves or modifies the FTD HA record associated with the specified ID. Creates or breaks or deletes a FTD HA pair. If no ID is specified for a GET, retrieves list of all FTD HA pairs.**", "operationId": "getFTDHADeviceContainer", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier of a FTD HA pair.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHADeviceContainer" }, "example": { "primary": { "id": "primary_uuid" }, "secondary": { "id": "secondary_uuid" }, "name": "", "type": "DeviceHAPair", "ftdHAFailoverTriggerCriteria": { "peerPollTime": 3, "noOfFailedInterfaceLimit": 1, "peerPollTimeUnit": "SEC", "peerHoldTimeUnit": "SEC", "peerHoldTime": 34, "interfacePollTime": 5, "interfacePollTimeUnit": "SEC", "interfaceHoldTime": 25 }, "ftdHABootstrap": { "isEncryptionEnabled": false, "encKeyGenerationScheme": "CUSTOM", "sharedKey": "cisco123", "useSameLinkForFailovers": true, "lanFailover": { "useIPv6Address": false, "subnetMask": "255.255.255.0", "interfaceObject": { "id": "", "type": "PhysicalInterface", "name": "GigabitEthernet0/0" }, "standbyIP": "1.1.1.2", "logicalName": "LAN-INTERFACE", "activeIP": "1.1.1.1" }, "statefulFailover": { "useIPv6Address": true, "subnetMask": "255.255.255.0", "interfaceObject": { "id": "", "type": "PhysicalInterface", "name": "GigabitEthernet0/0" }, "standbyIP": "1.1.1.2", "logicalName": "STATEFUL-INTERFACE", "activeIP": "1.1.1.1" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Device HA Pairs" ], "summary": "updateFTDHADeviceContainer", "description": "**Retrieves or modifies the FTD HA record associated with the specified ID. Creates or breaks or deletes a FTD HA pair. If no ID is specified for a GET, retrieves list of all FTD HA pairs. _Check the response section for applicable examples (if any)._**", "operationId": "updateFTDHADeviceContainer", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier of a FTD HA pair.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of FTD HA pair.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHADeviceContainer" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHADeviceContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Device HA Pairs" ], "summary": "deleteFTDHADeviceContainer", "description": "**Retrieves or modifies the FTD HA record associated with the specified ID. Creates or breaks or deletes a FTD HA pair. If no ID is specified for a GET, retrieves list of all FTD HA pairs. _Check the response section for applicable examples (if any)._**", "operationId": "deleteFTDHADeviceContainer", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier of a FTD HA pair.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDHADeviceContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_platform/v1/updates/upgradepackages": { "get": { "tags": [ "Updates" ], "summary": "getAllUpgradePackage", "description": "**API operation for listing upgrade packages.**", "operationId": "getAllUpgradePackage", "parameters": [ { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpgradePackageListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_platform/v1/updates/upgradepackages/{containerUUID}/applicabledevices": { "get": { "tags": [ "Updates" ], "summary": "getAllApplicableDevice", "description": "**Devices available for a particular upgrade package.**", "operationId": "getAllApplicableDevice", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicableDeviceListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_platform/v1/updates/upgradepackages/{objectId}": { "get": { "tags": [ "Updates" ], "summary": "getUpgradePackage", "description": "**API operation for listing upgrade packages.**", "operationId": "getUpgradePackage", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpgradePackage" }, "example": { "links": { "self": "https://u32c01p11-vrouter.cisco.com:18514/api/fmc_platform/v1/updates/upgradepackages?offset=0&limit=4" }, "items": [ { "metadata": { "upgradeType": "Cisco FTD Upgrade", "upgradeFileName": "Cisco_FTD_Upgrade-6.2.3-84.sh", "fileSize": 1038736, "updateVersion": "6.2.3-84 IMS 84", "upgradeFrom": "6.1.0", "uploadDate": "2018-04-04T01:28:31Z", "rebootRequired": true, "upgradeFileId": "Cisco FTD Upgrade / Wed Apr 4 01:28:28 UTC 2018" }, "name": "Cisco_FTD_Upgrade-6.2.3-84.sh", "links": { "self": "https://u32c01p11-vrouter.cisco.com:18514/api/fmc_platform/v1/updates/upgradepackages/b3e26a18-8392-11e8-b3c5-e4a3cc8a21de" }, "id": "b3e26a18-8392-11e8-b3c5-e4a3cc8a21de", "type": "UpgradePackage" }, { "metadata": { "upgradeType": "Cisco FTD Upgrade", "upgradeFileName": "Cisco_FTD_Upgrade-6.3.0-1256.sh", "fileSize": 1097772, "updateVersion": "6.3.0-1256 IMS 1256", "upgradeFrom": "6.1.0", "uploadDate": "2018-07-03T03:30:40Z", "rebootRequired": true, "upgradeFileId": "Cisco FTD Upgrade / Tue Jul 3 03:30:35 UTC 2018" }, "name": "Cisco_FTD_Upgrade-6.3.0-1256.sh", "links": { "self": "https://u32c01p11-vrouter.cisco.com:18514/api/fmc_platform/v1/updates/upgradepackages/b3e61096-8392-11e8-b3c5-e4a3cc8a21de" }, "id": "b3e61096-8392-11e8-b3c5-e4a3cc8a21de", "type": "UpgradePackage" }, { "metadata": { "upgradeType": "Cisco FTD SSP Upgrade", "upgradeFileName": "Cisco_FTD_SSP_Upgrade-6.3.0-10716.sh", "fileSize": 2244980, "updateVersion": "6.3.0-10716 IMS 10716", "upgradeFrom": "6.1.0", "uploadDate": "2018-06-24T15:06:31Z", "rebootRequired": true, "upgradeFileId": "Cisco FTD SSP Upgrade / Sun Jun 24 15:06:14 UTC 2018" }, "name": "Cisco_FTD_SSP_Upgrade-6.3.0-10716.sh", "links": { "self": "https://u32c01p11-vrouter.cisco.com:18514/api/fmc_platform/v1/updates/upgradepackages/8b0e576e-79dd-11e8-845b-e5a3cc8a21de" }, "id": "8b0e576e-79dd-11e8-845b-e5a3cc8a21de", "type": "UpgradePackage" }, { "metadata": { "upgradeType": "Cisco FTD Upgrade", "upgradeFileName": "Cisco_FTD_Upgrade-6.3.0-10716.sh", "fileSize": 1102216, "updateVersion": "6.3.0-10716 IMS 10716", "upgradeFrom": "6.1.0", "uploadDate": "2018-06-24T14:59:41Z", "rebootRequired": true, "upgradeFileId": "Cisco FTD Upgrade / Sun Jun 24 14:59:38 UTC 2018" }, "name": "Cisco_FTD_Upgrade-6.3.0-10716.sh", "links": { "self": "https://u32c01p11-vrouter.cisco.com:18514/api/fmc_platform/v1/updates/upgradepackages/8b0f623a-79dd-11e8-845b-e5a3cc8a21de" }, "id": "8b0f623a-79dd-11e8-845b-e5a3cc8a21de", "type": "UpgradePackage" } ], "paging": { "offset": 0, "limit": 4, "count": 4, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Updates" ], "summary": "deleteUpgradePackage", "description": "**API operation for listing upgrade packages. _Check the response section for applicable examples (if any)._**", "operationId": "deleteUpgradePackage", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpgradePackage" }, "example": { "metadata": { "upgradeType": "Cisco FTD SSP Upgrade", "upgradeFileName": "Cisco_FTD_SSP_Upgrade-6.3.0-1347.sh", "fileSize": 2337872, "updateVersion": "6.3.0-1347 IMS 1347", "upgradeFrom": "6.1.0", "uploadDate": "2018-07-27T21:30:05Z", "rebootRequired": true, "upgradeFileId": "Cisco FTD SSP Upgrade / Fri Jul 27 21:29:45 UTC 2018" }, "name": "Cisco_FTD_SSP_Upgrade-6.3.0-1347.sh", "links": { "self": "https://u32c01p11-vrouter.cisco.com:18514/api/fmc_platform/v1/updates/upgradepackages/ad4e78a0-948a-11e8-9f03-07873f284bf9" }, "id": "ad4e78a0-948a-11e8-9f03-07873f284bf9", "type": "UpgradePackage" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_platform/v1/updates/upgrades": { "post": { "tags": [ "Updates" ], "summary": "createUpgrade", "description": "**API to trigger upgrade. _Check the response section for applicable examples (if any)._**", "operationId": "createUpgrade", "parameters": [], "requestBody": { "description": "The input representation of Upgrade object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Upgrade" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Upgrade" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_tid/v1/domain/{domainUUID}/taxiiconfig/collections": { "post": { "tags": [ "Intelligence" ], "summary": "createRESTTaxiiCollection", "description": "**API Operations on Taxii Collection objects. _Check the response section for applicable examples (if any)._**", "operationId": "createRESTTaxiiCollection", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input Taxii Collection object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTTaxiiCollection" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTTaxiiCollection" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_tid/v1/domain/{domainUUID}/taxiiconfig/discoveryinfo": { "post": { "tags": [ "Intelligence" ], "summary": "createRESTDiscoveryInfo", "description": "**API Operations on Discovery Info objects. _Check the response section for applicable examples (if any)._**", "operationId": "createRESTDiscoveryInfo", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input Discovery Info object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTDiscoveryInfo" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTDiscoveryInfo" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_tid/v1/domain/{domainUUID}/tid/element": { "get": { "tags": [ "Intelligence" ], "summary": "getAllRESTElement", "description": "**API Operations on Element objects.**", "operationId": "getAllRESTElement", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTElementListContainer" }, "example": { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/elementUUID" }, "items": [ { "id": "elementUUID", "type": "element", "name": "Element Name" } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_tid/v1/domain/{domainUUID}/tid/element/{objectId}": { "get": { "tags": [ "Intelligence" ], "summary": "getRESTElement", "description": "**API Operations on Element objects.**", "operationId": "getRESTElement", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the Element.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTElement" }, "example": { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/element/elementUUID" }, "id": "elementUUID", "type": "element", "name": "Sample Element", "model": "Sample Model", "caCert": "-----BEGIN CACERTIFICATE-----\nMIIGLT...\n-----END CACERTIFICATE-----\n", "cert": "-----BEGIN CERTIFICATE-----\nMIIGLT...\n-----END CERTIFICATE-----\n", "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIJK...\n-----END RSA PRIVATE KEY-----\n", "status": "SampleStatus", "registrationDate": 1457566762, "miscData": { "policyName": "Sample Policy", "policyId": "Sample Policy Id", "tidStatus": "1" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_tid/v1/domain/{domainUUID}/tid/incident": { "get": { "tags": [ "Intelligence" ], "summary": "getAllRESTIncident", "description": "**API Operations on Incident objects.**", "operationId": "getAllRESTIncident", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTIncidentListContainer" }, "example": { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/incident?filter=updatedAt:1498629923..1499839523" }, "items": [ { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/incident/incidentUUID" }, "id": "incidentUUID", "type": "incident" }, { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/incident/incidentUUID" }, "id": "incidentUUID", "type": "incident" }, { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/incident/incidentUUID" }, "id": "incidentUUID", "type": "incident" }, { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/incident/incidentUUID" }, "id": "incidentUUID", "type": "incident" }, { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/incident/incidentUUID" }, "id": "incidentUUID", "type": "incident" }, { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/incident/incidentUUID" }, "id": "incidentUUID", "type": "incident" }, { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/incident/incidentUUID" }, "id": "incidentUUID", "type": "incident" } ], "paging": { "offset": 0, "limit": 7, "count": 7, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_tid/v1/domain/{domainUUID}/tid/incident/{objectId}": { "get": { "tags": [ "Intelligence" ], "summary": "getRESTIncident", "description": "**API Operations on Incident objects.**", "operationId": "getRESTIncident", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the Incident.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTIncident" }, "example": { "updatedAt": 1499839877, "sourceName": "Test URL Source", "equation": { "children": [ { "children": [ { "children": [ { "isRealized": true, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": true, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" } ], "isRealized": false, "op": "AND" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" } ], "isRealized": false, "op": "OR" }, "indicatorName": "Test Indicators", "observations": [ { "count": 1, "elementName": "elementName", "elementId": "elementUUID", "type": "observation", "data": { "miscData": { "appId": "HTTP", "clientId": "Wget", "connectionSec": "1498739289", "counter": "46", "destIpAddress": "ipAddressValue", "destPort": "80", "instanceId": "1", "protocol": "TCP", "srcIpAddress": "ipAddressValue", "srcPort": "39749", "userId": "No Authentication Required" }, "actionTaken": "none", "type": "SHA256", "value": "sha256Value" }, "timestamp": 1498739292 }, { "count": 2, "elementName": "elementName", "elementId": "elementUUID", "type": "observation", "data": { "miscData": { "appId": "HTTP", "clientId": "Wget", "connectionSec": "1498739351", "counter": "57", "destIpAddress": "ipAddressValue", "destPort": "80", "instanceId": "1", "protocol": "TCP", "srcIpAddress": "ipAddressValue", "srcPort": "39753", "userId": "No Authentication Required" }, "actionTaken": "blocked", "type": "SHA256", "value": "sha256Value" }, "timestamp": 1498739351 } ], "indicatorId": "indicatorUUID", "feedId": "feedUUID", "realizedAt": 0, "actionTaken": "partiallyBlocked", "property": { "ttl": 90, "whitelist": false, "expirationTime": 1506514284, "publish": true, "action": "monitor" }, "status": "new", "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/incident/incidentUUID" }, "id": "incidentUUID", "type": "incident", "version": "1.0.0" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Intelligence" ], "summary": "updateRESTIncident", "description": "**API Operations on Incident objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateRESTIncident", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the Incident.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input Incident object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTIncident" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTIncident" }, "example": { "updatedAt": 1499839877, "sourceName": "Test STIX Feed", "equation": { "children": [ { "children": [ { "isRealized": false, "type": "LL_UNSUPPORTED_OBJECT_TYPE|Port", "value": "IDREF:{http://hailataxii.com}Observable-fbdadbd3-dc8f-4f21-8736-1123903a056f" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "LL_UNSUPPORTED_OBJECT_TYPE|Port", "value": "IDREF:{http://hailataxii.com}Observable-ffed4f18-a648-4162-a088-a529f218ff96" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "IPV_4_ADDR", "value": "ipAddressValue" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": true, "type": "DomainNameObjectType", "value": "domainNameValue" } ], "condition": "EQUALS", "isRealized": true, "applyCondition": "ANY" } ], "isRealized": true, "op": "OR" }, "indicatorName": "Test Indicators", "observations": [ { "count": 1, "elementName": "elementName", "elementId": "elementUUID", "type": "observation", "data": { "miscData": { "appId": "DNS", "clientId": "DNS", "connectionSec": "1498739571", "counter": "77", "destIpAddress": "ipAddressValue", "destPort": "53", "destZone": "AutomatedInlineSZ", "dnsResponse": "No Error", "instanceId": "1", "protocol": "UDP", "srcIpAddress": "ipAddressValue", "srcPort": "41207", "srcZone": "AutomatedInlineSZ", "userId": "No Authentication Required" }, "actionTaken": "none", "type": "DomainNameObjectType", "value": "domainNameValue" }, "timestamp": 1498739571 } ], "indicatorId": "indicatorUUID", "feedId": "feedUUID", "realizedAt": 1498739604, "actionTaken": "monitored", "property": { "ttl": 90, "whitelist": false, "expirationTime": 1506514581, "publish": true, "action": "monitor" }, "status": "new", "id": "incidentUUID", "type": "incident", "version": "1.0.0", "name": "Incident" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Intelligence" ], "summary": "deleteRESTIncident", "description": "**API Operations on Incident objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteRESTIncident", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the Incident.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTIncident" }, "example": { "updatedAt": 1499839877, "sourceName": "Test URL Source", "equation": { "children": [ { "children": [ { "children": [ { "isRealized": true, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": true, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" } ], "isRealized": false, "op": "AND" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" }, { "children": [ { "isRealized": false, "type": "SHA256", "value": "sha256Value" } ], "condition": "EQUALS", "isRealized": false, "applyCondition": "ANY" } ], "isRealized": false, "op": "OR" }, "indicatorName": "Test Indicators", "observations": [ { "count": 1, "elementName": "elementName", "elementId": "elementUUID", "type": "observation", "data": { "miscData": { "appId": "HTTP", "clientId": "Wget", "connectionSec": "1498739289", "counter": "46", "destIpAddress": "ipAddressValue", "destPort": "80", "instanceId": "1", "protocol": "TCP", "srcIpAddress": "ipAddressValue", "srcPort": "39749", "userId": "No Authentication Required" }, "actionTaken": "none", "type": "SHA256", "value": "sha256Value" }, "timestamp": 1498739292 }, { "count": 2, "elementName": "elementName", "elementId": "elementUUID", "type": "observation", "data": { "miscData": { "appId": "HTTP", "clientId": "Wget", "connectionSec": "1498739351", "counter": "57", "destIpAddress": "ipAddressValue", "destPort": "80", "instanceId": "1", "protocol": "TCP", "srcIpAddress": "ipAddressValue", "srcPort": "39753", "userId": "No Authentication Required" }, "actionTaken": "blocked", "type": "SHA256", "value": "sha256Value" }, "timestamp": 1498739351 } ], "indicatorId": "indicatorUUID", "feedId": "feedUUID", "realizedAt": 0, "actionTaken": "partiallyBlocked", "property": { "ttl": 90, "whitelist": false, "expirationTime": 1506514284, "publish": true, "action": "monitor" }, "status": "new", "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/incident/incidentUUID" }, "id": "incidentUUID", "type": "incident", "version": "1.0.0" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_tid/v1/domain/{domainUUID}/tid/indicator": { "get": { "tags": [ "Intelligence" ], "summary": "getAllRESTIndicator", "description": "**API Operations on Indicator objects.**", "operationId": "getAllRESTIndicator", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTIndicatorListContainer" }, "example": { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/indicator" }, "items": [ { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/indicator/indicatorUUID" }, "id": "indicatorUUID", "type": "indicator", "name": "Sample Indicator" }, { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/indicator/indicatorUUID" }, "id": "indicatorUUID", "type": "indicator", "name": "Sample Indicator 2" }, { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/indicator/indicatorUUID" }, "id": "indicatorUUID", "type": "indicator", "name": "Sample Indicator 3" } ], "paging": { "offset": 0, "limit": 3, "count": 3, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_tid/v1/domain/{domainUUID}/tid/indicator/{objectId}": { "get": { "tags": [ "Intelligence" ], "summary": "getRESTIndicator", "description": "**API Operations on Indicator objects.**", "operationId": "getRESTIndicator", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the Indicator.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTIndicator" }, "example": { "inheritedProperty": { "ttl": 90, "publish": true, "whitelist": false, "expirationTime": 1506280028, "action": "monitor" }, "effectiveProperty": { "ttl": 90, "publish": true, "whitelist": false, "expirationTime": 1506280028, "action": "monitor" }, "customProperty": { "publish": true, "action": "monitor" }, "feedId": "feedUUID", "equation": { "children": [ { "children": [ { "isRealized": false, "type": "IPV_4_ADDR", "value": "IPV_4_ADDR:c4a098d02ba0407e165c14996f8eae6b65a119a2" } ], "condition": "EQUALS", "applyCondition": "ANY", "isRealized": false } ], "isRealized": false, "op": "OR" }, "updatedAt": 1499842559, "sourceName": "Test Flat File IPV4", "containsUnsupported": false, "containsInvalid": false, "observables": [ { "inheritedProperty": { "ttl": 90, "publish": true, "whitelist": false, "expirationTime": 1506280028, "action": "monitor" }, "effectiveProperty": { "ttl": 90, "publish": true, "whitelist": false, "expirationTime": 1506280028, "action": "monitor" }, "indicatorCount": 1, "observableType": "IPV_4_ADDR", "updatedAt": 1498504028, "value": "ipAddressValue", "id": "IPV_4_ADDR:c4a098d02ba0407e165c14996f8eae6b65a119a2", "type": "observable", "name": "Observable", "version": "1.0.0" } ], "indicatorVersion": "1.0.0", "noRealizedIncidents": 0, "noPartialIncidents": 0, "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/indicator/indicatorUUID" }, "id": "indicatorUUID", "type": "indicator", "name": "Sample Indicator", "version": "1.0.0", "description": "Indicator description" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Intelligence" ], "summary": "updateRESTIndicator", "description": "**API Operations on Indicator objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateRESTIndicator", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the Indicator.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input Indicator object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTIndicator" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTIndicator" }, "example": { "inheritedProperty": { "ttl": 90, "publish": true, "whitelist": false, "expirationTime": 1506280028, "action": "monitor" }, "effectiveProperty": { "ttl": 90, "publish": true, "whitelist": false, "expirationTime": 1506280028, "action": "monitor" }, "customProperty": { "publish": true, "action": "block" }, "feedId": "feedUUID", "equation": { "children": [ { "children": [ { "isRealized": false, "type": "IPV_4_ADDR", "value": "IPV_4_ADDR:c4a098d02ba0407e165c14996f8eae6b65a119a2" } ], "condition": "EQUALS", "applyCondition": "ANY", "isRealized": false } ], "isRealized": false, "op": "OR" }, "updatedAt": 1499842559, "sourceName": "Test Flat File IPV4", "containsUnsupported": false, "containsInvalid": false, "observables": [ { "inheritedProperty": { "ttl": 90, "publish": true, "whitelist": false, "expirationTime": 1506280028, "action": "monitor" }, "effectiveProperty": { "ttl": 90, "publish": true, "whitelist": false, "expirationTime": 1506280028, "action": "monitor" }, "indicatorCount": 1, "observableType": "IPV_4_ADDR", "updatedAt": 1498504028, "value": "ipAddressValue", "id": "IPV_4_ADDR:c4a098d02ba0407e165c14996f8eae6b65a119a2", "type": "observable", "name": "Observable", "version": "1.0.0" } ], "indicatorVersion": "1.0.0", "noRealizedIncidents": 0, "noPartialIncidents": 0, "id": "indicatorUUID", "type": "indicator", "name": "Sample Indicator IPV4", "version": "1.0.0", "description": "Indicator description changed" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_tid/v1/domain/{domainUUID}/tid/observable": { "get": { "tags": [ "Intelligence" ], "summary": "getAllRESTObservable", "description": "**API Operations on Observable objects.**", "operationId": "getAllRESTObservable", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTObservableListContainer" }, "example": { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/observable" }, "items": [ { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/observable/observableUUID" }, "type": "observable", "name": "Observable name 1" }, { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/observable/observableUUID" }, "type": "observable", "name": "Observable name 2" } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_tid/v1/domain/{domainUUID}/tid/observable/{objectId}": { "get": { "tags": [ "Intelligence" ], "summary": "getRESTObservable", "description": "**API Operations on Observable objects.**", "operationId": "getRESTObservable", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the Observable.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTObservable" }, "example": { "inheritedProperty": { "publish": true, "expirationTime": 1493929252, "whitelist": false, "action": "monitor", "ttl": 90 }, "observableType": "IPV_4_ADDR", "effectiveProperty": { "publish": true, "expirationTime": 1493929252, "whitelist": false, "action": "monitor", "ttl": 90 }, "indicatorCount": 1, "updatedAt": 1486153252, "value": "ipAddressValue", "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/observable/observableUUID" }, "id": "observableUUID", "type": "observable", "name": "Observable name", "version": "1.0.0" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Intelligence" ], "summary": "updateRESTObservable", "description": "**API Operations on Observable objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateRESTObservable", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the Observable.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input Observable object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTObservable" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTObservable" }, "example": { "inheritedProperty": { "publish": true, "expirationTime": 1493929252, "whitelist": false, "action": "monitor", "ttl": 90 }, "observableType": "IPV_4_ADDR", "effectiveProperty": { "publish": true, "expirationTime": 1493929252, "whitelist": false, "action": "monitor", "ttl": 90 }, "indicatorCount": 1, "updatedAt": 1486153252, "value": "ipAddressValue", "id": "observableUUID", "type": "observable", "name": "Observable name 2", "version": "1.0.0", "customProperty": { "whitelist": true } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_tid/v1/domain/{domainUUID}/tid/settings/{objectId}": { "get": { "tags": [ "Intelligence" ], "summary": "getRESTSettings", "description": "**API Operations on Settings objects.**", "operationId": "getRESTSettings", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the Settings object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTSettings" }, "example": { "id": "publish_observables", "type": "settings", "version": "1.0.0", "settings": { "publish_observables": true } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Intelligence" ], "summary": "updateRESTSettings", "description": "**API Operations on Settings objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateRESTSettings", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the Settings object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input Settings object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTSettings" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTSettings" }, "example": { "id": "publish_observables", "type": "settings", "settings": { "publish_observables": false } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_tid/v1/domain/{domainUUID}/tid/source": { "get": { "tags": [ "Intelligence" ], "summary": "getAllRESTTidSource", "description": "**API Operations on Source objects.**", "operationId": "getAllRESTTidSource", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTTidSourceListContainer" }, "example": { "links": { "self": "/fmc_tid/v1/domain/domainUUID/tid/source" }, "items": [ { "id": "sourceUUID", "type": "source", "name": "Test URL Feed" }, { "id": "sourceUUID", "type": "source", "name": "Test Flat File Domain Feed" }, { "id": "sourceUUID", "type": "source", "name": "Test TAXII Feed" }, { "id": "sourceUUID", "type": "source", "name": "Test TAXII Feed 2" } ], "paging": { "offset": 0, "limit": 4, "count": 4, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Intelligence" ], "summary": "createRESTTidSource", "description": "**API Operations on Source objects. _Check the response section for applicable examples (if any)._**", "operationId": "createRESTTidSource", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input Source object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTTidSource" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTTidSource" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_tid/v1/domain/{domainUUID}/tid/source/{objectId}": { "get": { "tags": [ "Intelligence" ], "summary": "getRESTTidSource", "description": "**API Operations on Source objects.**", "operationId": "getRESTTidSource", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the Source.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTTidSource" }, "example": { "uri": "http://somehost/feeds/domain.txt", "params": { "selfSignedServerCertificate": "false", "hostnameVerifier": "allow_all", "pollInterval": "86400" }, "nextRun": 1499922000, "consumedUnsupportedObservables": 0, "checksum": "6A330EFFD42314B74C030C0038BAB3352F70CC5344D6CE24774BD04EFDEDB7BD", "lastRun": 1499836832, "totalUnsupportedObservables": 0, "totalInvalidObservables": 0, "downloadOn": true, "runNow": false, "feedStatus": "parsing", "consumedIndicators": 0, "totalIndicators": 0, "discardedIndicators": 0, "totalDiscardedIndicators": 0, "totalObservables": 0, "invalidObservables": 0, "consumedObservables": 501, "feedType": "flatfile", "feedContent": "DomainNameObjectType", "delivery": "url", "refresh": 1440, "property": { "ttl": 80, "whitelist": false, "expirationTime": 1506749351, "publish": true, "action": "block" }, "id": "sourceUUID", "type": "source", "name": "Test URL Source", "description": "Test URL Source" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Intelligence" ], "summary": "updateRESTTidSource", "description": "**API Operations on Source objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateRESTTidSource", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the Source.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input Source object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTTidSource" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTTidSource" }, "example": { "uri": "http://somehost/feeds/domain.txt", "params": { "selfSignedServerCertificate": "false", "hostnameVerifier": "allow_all" }, "nextRun": 1499922000, "consumedUnsupportedObservables": 0, "checksum": "6A330EFFD42314B74C030C0038BAB3352F70CC5344D6CE24774BD04EFDEDB7BD", "lastRun": 1499836832, "totalUnsupportedObservables": 0, "totalInvalidObservables": 0, "downloadOn": true, "runNow": false, "feedStatus": "parsing", "consumedIndicators": 0, "totalIndicators": 0, "discardedIndicators": 0, "totalDiscardedIndicators": 0, "totalObservables": 0, "invalidObservables": 0, "consumedObservables": 501, "feedType": "flatfile", "feedContent": "DomainNameObjectType", "delivery": "url", "refresh": 1440, "property": { "ttl": 80, "publish": true, "action": "block" }, "id": "sourceUUID", "type": "source", "name": "Test URL Source", "description": "Test URL Source", "caCert": "" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Intelligence" ], "summary": "deleteRESTTidSource", "description": "**API Operations on Source objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteRESTTidSource", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the Source.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RESTTidSource" }, "example": { "uri": "NTAyNTVjOTJjNjAzYWUzOWNlOTE3N2UyNzkxMTI4YTE5YzUzODU3MQ", "params": { "selfSignedServerCertificate": "false", "hostnameVerifier": "allow_all", "job": "85eaa1fb-7250-4db5-865e-622030a155d7" }, "statusMsg": { "0": { "info": "Operation completed successfully." } }, "nextRun": 0, "consumedUnsupportedObservables": 0, "checksum": "AD8E91B35B7F2EA8F99996EF49C1C9A43A86D6A271AE19782D5D31BF834BEE2A", "lastRun": 1499836436, "totalUnsupportedObservables": 0, "totalInvalidObservables": 0, "downloadOn": false, "runNow": false, "feedStatus": "completed", "finishTime": 1499836437, "consumedIndicators": 1, "totalIndicators": 1, "discardedIndicators": 0, "totalDiscardedIndicators": 0, "totalObservables": 0, "invalidObservables": 0, "consumedObservables": 1, "feedType": "flatfile", "feedContent": "IPV_4_ADDR", "delivery": "upload", "refresh": 0, "property": { "ttl": 90, "whitelist": false, "expirationTime": 1507612436, "publish": true, "action": "monitor" }, "username": "username", "id": "sourceUUID", "type": "source", "name": "Test STIX Source" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_platform/v1/domain/{domainUUID}/audit/auditrecords": { "get": { "tags": [ "Audit" ], "summary": "getAllAuditModel", "description": "**API Operations on audit objects.**", "operationId": "getAllAuditModel", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditModelListContainer" }, "example": { "links": { "self": "https://example.cisco.com/api/fmc_platform/v1/domain/default/audit/auditrecords?offset=0&limit=4" }, "items": [ { "time": 1460055526, "username": "admin", "message": "New session source IP - 127.0.0.1:", "subSystem": "Session Expiration", "source": "127.0.0.1", "domain": "Global-domain-UUID" }, { "time": 1460055526, "username": "admin", "message": "Login Success:", "subSystem": "Login", "source": "127.0.0.1", "domain": "Global-domain-UUID" }, { "time": 1460055515, "message": "GET https://example.cisco.com/api/fmc_platform/v1/domain/default/audit/auditrecords Unauthorized (401) - The request requires user authentication:", "subSystem": "API", "source": "10.150.162.23", "domain": "Global-domain-UUID" }, { "time": 1460054229, "username": "admin", "message": "Login Success:", "subSystem": "Login", "source": "127.0.0.1", "domain": "Global-domain-UUID" } ], "paging": { "offset": 0, "limit": 4, "count": 4, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_platform/v1/domain/{domainUUID}/audit/auditrecords/{objectId}": { "get": { "tags": [ "Audit" ], "summary": "getAuditModel", "description": "**API Operations on audit objects.**", "operationId": "getAuditModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditModel" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devicegroups/devicegrouprecords": { "get": { "tags": [ "Device Groups" ], "summary": "getAllDeviceGroup", "description": "**Retrieves, deletes, creates, or modifies the device group associated with the specified ID. If no ID is specified for a GET, retrieves list of all device groups.**", "operationId": "getAllDeviceGroup", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceGroupListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Device Groups" ], "summary": "createDeviceGroup", "description": "**Retrieves, deletes, creates, or modifies the device group associated with the specified ID. If no ID is specified for a GET, retrieves list of all device groups. _Check the response section for applicable examples (if any)._**", "operationId": "createDeviceGroup", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of device group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceGroup" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceGroup" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/devicegroups/devicegrouprecords/{objectId}": { "get": { "tags": [ "Device Groups" ], "summary": "getDeviceGroup", "description": "**Retrieves, deletes, creates, or modifies the device group associated with the specified ID. If no ID is specified for a GET, retrieves list of all device groups.**", "operationId": "getDeviceGroup", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for a device group.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceGroup" }, "example": { "id": "deviceGroupUUID", "type": "DeviceGroup", "name": "zoom2", "links": { "self": "/fmc_config/v1/domain/domainUUID/devicegroups/devicegrouprecords/deviceGroupUUID" }, "members": [ { "id": "deviceUUID", "type": "Device", "name": "deviceName", "links": { "self": "/api/fmc_config/v1/domain/default/devices/devicerecords/deviceUUID" } } ], "metadata": { "domain": { "id": "domainUUID", "type": "Domain", "name": "Global" }, "lastUser": { "name": "admin", "id": "userUUID", "type": "User" }, "readOnly": { "state": true } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Device Groups" ], "summary": "updateDeviceGroup", "description": "**Retrieves, deletes, creates, or modifies the device group associated with the specified ID. If no ID is specified for a GET, retrieves list of all device groups. _Check the response section for applicable examples (if any)._**", "operationId": "updateDeviceGroup", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for a device group.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of device group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceGroup" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceGroup" }, "example": { "name": "zoom3_upd", "type": "DeviceGroup", "id": "deviceGroupUUID", "members": [ { "id": "deviceUUID", "type": "Device", "name": "deviceName" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Device Groups" ], "summary": "deleteDeviceGroup", "description": "**Retrieves, deletes, creates, or modifies the device group associated with the specified ID. If no ID is specified for a GET, retrieves list of all device groups. _Check the response section for applicable examples (if any)._**", "operationId": "deleteDeviceGroup", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for a device group.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceGroup" }, "example": { "name": "test1", "type": "DeviceGroup", "id": "devicegroupUUID", "links": { "self": "/fmc_config/v1/domain/domainUUID/devicegroups/devicegrouprecords/devicegroupUUID" }, "members": [ { "id": "deviceUUID", "type": "Device", "name": "deviceName", "links": { "self": "/api/fmc_config/v1/domain/default/devices/devicerecords/deviceUUID" } } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/integration/cloudeventsconfigs": { "get": { "tags": [ "Integration" ], "summary": "getAllCloudEvents", "description": "**Retrieves or modifies the cloud event configuration associated with the specified ID. If no ID is specified for a GET, retrieves a list of the singleton cloud event configuration object.**", "operationId": "getAllCloudEvents", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudEventsListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/integration/cloudeventsconfigs?offset=0&limit=1" }, "items": [ { "id": "CloudEventsConfigsUUID", "type": "CloudEventsConfigs", "links": { "self": "/fmc_config/v1/domain/domainUUID/integration/cloudeventsconfigs/CloudEventsConfigsUUID" } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/integration/cloudeventsconfigs/{objectId}": { "get": { "tags": [ "Integration" ], "summary": "getCloudEvents", "description": "**Retrieves or modifies the cloud event configuration associated with the specified ID. If no ID is specified for a GET, retrieves a list of the singleton cloud event configuration object.**", "operationId": "getCloudEvents", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for cloud event configuration.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudEvents" }, "example": { "id": "CloudEventsConfigsUUID", "type": "CloudEventsConfig", "sendIntrusionEvents": true, "links": { "self": "/fmc_config/v1/domain/DomainUUID/integration/cloudeventsconfigs/CloudEventsConfigsUUID" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Integration" ], "summary": "updateCloudEvents", "description": "**Retrieves or modifies the cloud event configuration associated with the specified ID. If no ID is specified for a GET, retrieves a list of the singleton cloud event configuration object. _Check the response section for applicable examples (if any)._**", "operationId": "updateCloudEvents", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for cloud event configuration.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of cloud event configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudEvents" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudEvents" }, "example": { "id": "CloudEventsConfigsUUID", "type": "CloudEventsConfig", "sendIntrusionEvents": false } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/integration/externallookups": { "get": { "tags": [ "Integration" ], "summary": "getAllExternalLookup", "description": "**Retrieves, deletes, creates, or modifies the external lookup associated with the specified ID. If no ID is specified for a GET, retrieves list of all external lookups.**", "operationId": "getAllExternalLookup", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLookupListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/integration/externallookups?offset=0&limit=25" }, "items": [ { "id": "ExternalLookupUUID", "type": "ExternalLookup", "name": "test1055", "links": { "self": "/fmc_config/v1/domain/DomainUUID/integration/externallookups/ExternalLookupUUID" } } ], "paging": { "offset": 0, "limit": 25, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Integration" ], "summary": "createExternalLookup", "description": "**Retrieves, deletes, creates, or modifies the external lookup associated with the specified ID. If no ID is specified for a GET, retrieves list of all external lookups. _Check the response section for applicable examples (if any)._**", "operationId": "createExternalLookup", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of external lookup.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLookup" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLookup" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/integration/externallookups/{objectId}": { "get": { "tags": [ "Integration" ], "summary": "getExternalLookup", "description": "**Retrieves, deletes, creates, or modifies the external lookup associated with the specified ID. If no ID is specified for a GET, retrieves list of all external lookups.**", "operationId": "getExternalLookup", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for an external lookup.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLookup" }, "example": { "id": "ExternalLookupUUID", "type": "ExternalLookup", "name": "test1055", "links": { "self": "/fmc_config/v1/domain/DomainUUID/integration/externallookups/ExternalLookupUUID" }, "template": "http://www.example.com/{ip}", "enabled": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Integration" ], "summary": "updateExternalLookup", "description": "**Retrieves, deletes, creates, or modifies the external lookup associated with the specified ID. If no ID is specified for a GET, retrieves list of all external lookups. _Check the response section for applicable examples (if any)._**", "operationId": "updateExternalLookup", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for an external lookup.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of external lookup.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLookup" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLookup" }, "example": { "name": "change_name", "template": "http://www.example.com", "enabled": true, "type": "ExternalLookup", "id": "ExternalLookupUUID" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Integration" ], "summary": "deleteExternalLookup", "description": "**Retrieves, deletes, creates, or modifies the external lookup associated with the specified ID. If no ID is specified for a GET, retrieves list of all external lookups. _Check the response section for applicable examples (if any)._**", "operationId": "deleteExternalLookup", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for an external lookup.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLookup" }, "example": { "id": "ExternalLookupUUID", "type": "ExternalLookup", "name": "test", "links": { "self": "/fmc_config/v1/domain/DomainUUID/integration/externallookups/ExternalLookupUUID" }, "template": "http://www.example.com", "enabled": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/integration/packetanalyzerdevices": { "get": { "tags": [ "Integration" ], "summary": "getAllPacketAnalyzerDevice", "description": "**Retrieves, deletes, creates, or modifies the packet analyzer device associated with the specified ID. If no ID is specified for a GET, retrieves list of all packet analyzer devices.**", "operationId": "getAllPacketAnalyzerDevice", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PacketAnalyzerDeviceListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/integration/packetanalyzerdevices?offset=0&limit=25" }, "items": [ { "id": "PacketAnalyzerDeviceUUID", "type": "PacketAnalyzerDevice", "name": "test1055", "links": { "self": "/fmc_config/v1/domain/DomainUUID/integration/packetanalyzerdevices/PacketAnalyzerDeviceUUID" } } ], "paging": { "offset": 0, "limit": 25, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Integration" ], "summary": "createPacketAnalyzerDevice", "description": "**Retrieves, deletes, creates, or modifies the packet analyzer device associated with the specified ID. If no ID is specified for a GET, retrieves list of all packet analyzer devices. _Check the response section for applicable examples (if any)._**", "operationId": "createPacketAnalyzerDevice", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of packet analyzer device.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PacketAnalyzerDevice" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PacketAnalyzerDevice" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/integration/packetanalyzerdevices/{objectId}": { "get": { "tags": [ "Integration" ], "summary": "getPacketAnalyzerDevice", "description": "**Retrieves, deletes, creates, or modifies the packet analyzer device associated with the specified ID. If no ID is specified for a GET, retrieves list of all packet analyzer devices.**", "operationId": "getPacketAnalyzerDevice", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for a packet analyzer device.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PacketAnalyzerDevice" }, "example": { "username": "admin", "id": "PacketAnalyzerDeviceUUID", "type": "PacketAnalyzerDevice", "name": "test1055", "links": { "self": "/fmc_config/v1/domain/DomainUUID/integration/packetanalyzerdevices/PacketAnalyzerDeviceUUID" }, "host": "PacketAnalyzerHost", "port": 443 } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Integration" ], "summary": "updatePacketAnalyzerDevice", "description": "**Retrieves, deletes, creates, or modifies the packet analyzer device associated with the specified ID. If no ID is specified for a GET, retrieves list of all packet analyzer devices. _Check the response section for applicable examples (if any)._**", "operationId": "updatePacketAnalyzerDevice", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for a packet analyzer device.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of packet analyzer device.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PacketAnalyzerDevice" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PacketAnalyzerDevice" }, "example": { "name": "change_name", "host": "PacketAnalyzerHost", "username": "admin", "password": "####", "port": 443, "type": "PacketAnalyzerDevice", "captureSession": "capture_session_name", "insecure": 1, "cacert": "", "id": "PacketAnalyzerDeviceUUID" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Integration" ], "summary": "deletePacketAnalyzerDevice", "description": "**Retrieves, deletes, creates, or modifies the packet analyzer device associated with the specified ID. If no ID is specified for a GET, retrieves list of all packet analyzer devices. _Check the response section for applicable examples (if any)._**", "operationId": "deletePacketAnalyzerDevice", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for a packet analyzer device.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PacketAnalyzerDevice" }, "example": { "username": "admin", "id": "PacketAnalyzerDeviceUUID", "type": "PacketAnalyzerDevice", "name": "test", "links": { "self": "/fmc_config/v1/domain/DomainUUID/integration/packetanalyzerdevices/PacketAnalyzerDeviceUUID" }, "host": "PacketAnalyzerHost", "port": 443 } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/job/taskstatuses/{objectId}": { "get": { "tags": [ "Status" ], "summary": "getTaskStatus", "description": "**Retrieves information about a previously submitted pending job/task with the specified ID.**", "operationId": "getTaskStatus", "parameters": [ { "name": "objectId", "in": "path", "description": "UUID of request.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatus" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/deviceclusters/ftddevicecluster": { "get": { "tags": [ "Device Clusters" ], "summary": "getAllFTDClusterDeviceContainer", "description": "**Retrieves or modifies the FTD Cluster record associated with the specified ID. If no ID is specified for a GET, retrieves list of all FTD Clusters.**", "operationId": "getAllFTDClusterDeviceContainer", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDClusterDeviceContainerListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/deviceclusters/ftddevicecluster/{objectId}": { "get": { "tags": [ "Device Clusters" ], "summary": "getFTDClusterDeviceContainer", "description": "**Retrieves or modifies the FTD Cluster record associated with the specified ID. If no ID is specified for a GET, retrieves list of all FTD Clusters.**", "operationId": "getFTDClusterDeviceContainer", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier of a FTD Cluster.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDClusterDeviceContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_platform/v1/info/serverversion": { "get": { "tags": [ "System Information" ], "summary": "getAllServerVersion", "description": "**API Operation for Server Version.**", "operationId": "getAllServerVersion", "parameters": [ { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerVersionListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_platform/v1/info/serverversion/{objectId}": { "get": { "tags": [ "System Information" ], "summary": "getServerVersion", "description": "**API Operation for Server Version.**", "operationId": "getServerVersion", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerVersion" }, "example": { "type": "ServerVersion", "description": "System Version", "serverversion": "Version Number", "links": { "self": "https://example.cisco.com/api/fmc_platform/v1/info/serverversion" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies": { "get": { "tags": [ "Policy" ], "summary": "getAllAccessPolicy", "description": "**Retrieves, deletes, creates, or modifies the access control policy associated with the specified ID. Also, retrieves list of all access control policies.**", "operationId": "getAllAccessPolicy", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessPolicyListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Policy" ], "summary": "createAccessPolicy", "description": "**Retrieves, deletes, creates, or modifies the access control policy associated with the specified ID. Also, retrieves list of all access control policies. _Check the response section for applicable examples (if any)._**", "operationId": "createAccessPolicy", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of access control policy.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessPolicy" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessPolicy" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/accessrules": { "get": { "tags": [ "Policy" ], "summary": "getAllAccessRule", "description": "**Retrieves, deletes, creates, or modifies the access control rule associated with the specified policy ID and rule ID. If no ID is specified, retrieves list of all access rules associated with the specified policy ID.**", "operationId": "getAllAccessRule", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRuleListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules?offset=0&limit=2" }, "items": [ { "metadata": { "readOnly": { "state": true, "reason": "SYSTEM" } }, "links": { "self": "/fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessRuleUUID2" }, "action": "ALLOW", "enabled": true, "type": "AccessRule", "name": "Rule1", "sendEventsToFMC": false, "originalSourceNetworks": {}, "id": "accessRuleUUID2", "vlanTags": { "objects": [ { "type": "VlanTag", "name": "vlan_tag_1", "id": "VlanTagUUID" } ] }, "sourceNetworks": {}, "destinationNetworks": {}, "logFiles": false, "logBegin": false, "logEnd": false, "variableSet": { "name": "Default Set", "id": "VariableSetUUID", "type": "VariableSet" }, "sourcePorts": { "objects": [ { "type": "ProtocolPortObject", "name": "AOL", "id": "ProtocolPortObjectUUID" } ] }, "destinationPorts": { "objects": [ { "type": "ProtocolPortObject", "name": "Bittorrent", "id": "ProtocolPortObjectUUID" } ] } }, { "metadata": { "readOnly": { "state": true, "reason": "SYSTEM" } }, "links": { "self": "/fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessRuleUUID1" }, "action": "ALLOW", "enabled": true, "type": "AccessRule", "name": "Rule2", "sendEventsToFMC": false, "ipsPolicy": { "name": "Connectivity Over Security", "id": "IntrusionPolicyUUID", "type": "IntrusionPolicy" }, "originalSourceNetworks": {}, "id": "accessRuleUUID1", "vlanTags": { "objects": [ { "type": "VlanTag", "name": "vlan_tag_1", "id": "VlanTagUUID" } ] }, "urls": { "urlCategoriesWithReputation": [ { "type": "UrlCategoryAndReputation", "category": { "name": "Weapons", "id": "URLCategoryUUID", "type": "URLCategory" }, "reputation": "BENIGN_SITES_WITH_SECURITY_RISKS" } ] }, "sourceZones": { "objects": [ { "name": "External", "id": "SecurityZone", "type": "SecurityZone" } ] }, "destinationZones": { "objects": [ { "name": "Internal", "id": "SecurityZone", "type": "SecurityZone" } ] }, "logFiles": false, "logBegin": false, "logEnd": false, "variableSet": { "name": "Default Set", "id": "VariableSetUUID", "type": "VariableSet" }, "sourcePorts": { "objects": [ { "type": "ProtocolPortObject", "name": "AOL", "id": "ProtocolPortObjectUUID" } ] }, "destinationPorts": { "objects": [ { "type": "ProtocolPortObject", "name": "Bittorrent", "id": "ProtocolPortObjectUUID" } ] }, "applications": { "applications": [ { "id": "applictaionUUID", "type": "Application", "name": "1&1 Internet" } ] } } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Policy" ], "summary": "createAccessRule", "description": "**Retrieves, deletes, creates, or modifies the access control rule associated with the specified policy ID and rule ID. If no ID is specified, retrieves list of all access rules associated with the specified policy ID. _Check the response section for applicable examples (if any)._**", "operationId": "createAccessRule", "parameters": [ { "name": "bulk", "in": "query", "description": "This parameter specififes that bulk operation is being used in the query. This parameter is required for bulk rule operations.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "insertAfter", "in": "query", "description": "This parameter specifies that the rules will be inserted after the specified rule index. If no section or category is specified, the rules will be added to the section or category after the insertion point. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "insertBefore", "in": "query", "description": "This parameter specifies that the rules will be inserted before the specified rule index. If no section or category is specified, the rules will be added to the section or category before the insertion point. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "section", "in": "query", "description": "This parameter specifies the section into which the rules will be added. If this parameter is not used the section will be the default section. Only 'mandatory' and 'default' are allowed values. If a section is specified, a category cannot be specified.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "This parameter specifies the category into which the rules will be added. If a category is specified it must exist or the request will fail. If a section is specified, a category cannot be specified.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input access control rule model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRule" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRule" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updateAccessRule1", "description": "**Retrieves, deletes, creates, or modifies the access control rule associated with the specified policy ID and rule ID. If no ID is specified, retrieves list of all access rules associated with the specified policy ID. _Check the response section for applicable examples (if any)._**", "operationId": "updateAccessRule1", "parameters": [ { "name": "bulk", "in": "query", "description": "This parameter specififes that bulk operation is being used in the query. This parameter is required for bulk rule operations.", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input access control rule model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRule" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRule" }, "example": { "action": "ALLOW", "enabled": false, "type": "AccessRule", "name": "Rule2", "sendEventsToFMC": false, "id": "accessRuleUUID1", "vlanTags": { "objects": [ { "type": "VlanTag", "name": "vlan_tag_1", "id": "VlanTagUUID1" }, { "type": "VlanTag", "name": "vlan_tag_2", "id": "VlanTagUUID2" } ] }, "urls": { "urlCategoriesWithReputation": [ { "type": "UrlCategoryAndReputation", "category": { "name": "Weapons", "id": "URLCategoryUUID", "type": "URLCategory" }, "reputation": "BENIGN_SITES_WITH_SECURITY_RISKS" } ] }, "sourceZones": { "objects": [ { "name": "External", "id": "SecurityZoneUUID", "type": "SecurityZone" } ] }, "destinationZones": { "objects": [ { "name": "Internal", "id": "SecurityZoneUUID", "type": "SecurityZone" } ] }, "logFiles": false, "logBegin": false, "logEnd": false, "variableSet": { "name": "Default Set", "id": "VariableSetUUID", "type": "VariableSet" }, "sourcePorts": { "objects": [ { "type": "ProtocolPortObject", "name": "AOL", "id": "ProtocolPortObjectUUID" } ] }, "destinationPorts": { "objects": [ { "type": "ProtocolPortObject", "name": "Bittorrent", "id": "ProtocolPortObjectUUID" } ] }, "ipsPolicy": { "type": "IntrusionPolicy", "id": "ipsPolicyUuid", "name": "ipsPlicyName" }, "filePolicy": { "type": "FilePolicy", "id": "filePolicyUuid", "name": "filePolicyName" }, "snmpConfig": { "id": "snmpConfigUuid", "name": "snmp_alert1", "type": "SNMPAlert" }, "syslogConfig": { "id": "syslogConfigUuid", "name": "syslog_alert1", "type": "SyslogAlert" }, "newComments": [ "comment1", "comment2" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/accessrules/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getAccessRule", "description": "**Retrieves, deletes, creates, or modifies the access control rule associated with the specified policy ID and rule ID. If no ID is specified, retrieves list of all access rules associated with the specified policy ID.**", "operationId": "getAccessRule", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of an access control rule.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRule" }, "example": { "metadata": { "readOnly": { "state": true, "reason": "SYSTEM" } }, "links": { "self": "/fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessruleUUID" }, "action": "ALLOW", "enabled": true, "type": "AccessRule", "name": "Rule2", "sendEventsToFMC": false, "ipsPolicy": { "name": "Connectivity Over Security", "id": "ipsPolicyUUID", "type": "IntrusionPolicy" }, "originalSourceNetworks": {}, "id": "accessruleUUID", "vlanTags": { "objects": [ { "type": "VlanTag", "name": "vlan_tag_1", "id": "vlanTagUUID" } ] }, "urls": { "urlCategoriesWithReputation": [ { "type": "UrlCategoryAndReputation", "category": { "name": "Weapons", "id": "categoryUUID", "type": "URLCategory" }, "reputation": "BENIGN_SITES_WITH_SECURITY_RISKS" } ] }, "sourceZones": { "objects": [ { "name": "External", "id": "sourceZoneObjectUUID", "type": "SecurityZone" } ] }, "destinationZones": { "objects": [ { "name": "Internal", "id": "destinationZonesUUID", "type": "SecurityZone" } ] }, "logFiles": false, "logBegin": false, "logEnd": false, "variableSet": { "name": "Default Set", "id": "variableSetUUID", "type": "VariableSet" }, "sourcePorts": { "objects": [ { "type": "ProtocolPortObject", "name": "AOL", "id": "ProtocolPortObjectUUID" } ] }, "destinationPorts": { "objects": [ { "type": "ProtocolPortObject", "name": "Bittorrent", "id": "ProtocolPortObjectUUID" } ] }, "applications": { "applications": [ { "id": "1553", "type": "Application", "name": "1&1 Internet" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updateAccessRule", "description": "**Retrieves, deletes, creates, or modifies the access control rule associated with the specified policy ID and rule ID. If no ID is specified, retrieves list of all access rules associated with the specified policy ID. _Check the response section for applicable examples (if any)._**", "operationId": "updateAccessRule", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of an access control rule.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input access control rule model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRule" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRule" }, "example": { "action": "ALLOW", "enabled": false, "type": "AccessRule", "name": "Rule2", "sendEventsToFMC": false, "id": "accessRuleUUID1", "vlanTags": { "objects": [ { "type": "VlanTag", "name": "vlan_tag_1", "id": "VlanTagUUID1" }, { "type": "VlanTag", "name": "vlan_tag_2", "id": "VlanTagUUID2" } ] }, "urls": { "urlCategoriesWithReputation": [ { "type": "UrlCategoryAndReputation", "category": { "name": "Weapons", "id": "URLCategoryUUID", "type": "URLCategory" }, "reputation": "BENIGN_SITES_WITH_SECURITY_RISKS" } ] }, "sourceZones": { "objects": [ { "name": "External", "id": "SecurityZoneUUID", "type": "SecurityZone" } ] }, "destinationZones": { "objects": [ { "name": "Internal", "id": "SecurityZoneUUID", "type": "SecurityZone" } ] }, "logFiles": false, "logBegin": false, "logEnd": false, "variableSet": { "name": "Default Set", "id": "VariableSetUUID", "type": "VariableSet" }, "sourcePorts": { "objects": [ { "type": "ProtocolPortObject", "name": "AOL", "id": "ProtocolPortObjectUUID" } ] }, "destinationPorts": { "objects": [ { "type": "ProtocolPortObject", "name": "Bittorrent", "id": "ProtocolPortObjectUUID" } ] }, "ipsPolicy": { "type": "IntrusionPolicy", "id": "ipsPolicyUuid", "name": "ipsPlicyName" }, "filePolicy": { "type": "FilePolicy", "id": "filePolicyUuid", "name": "filePolicyName" }, "snmpConfig": { "id": "snmpConfigUuid", "name": "snmp_alert1", "type": "SNMPAlert" }, "syslogConfig": { "id": "syslogConfigUuid", "name": "syslog_alert1", "type": "SyslogAlert" }, "newComments": [ "comment1", "comment2" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Policy" ], "summary": "deleteAccessRule", "description": "**Retrieves, deletes, creates, or modifies the access control rule associated with the specified policy ID and rule ID. If no ID is specified, retrieves list of all access rules associated with the specified policy ID. _Check the response section for applicable examples (if any)._**", "operationId": "deleteAccessRule", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of an access control rule.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRule" }, "example": { "metadata": { "readOnly": { "state": true, "reason": "SYSTEM" } }, "links": { "self": "/fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessRuleUUID" }, "action": "ALLOW", "enabled": true, "type": "AccessRule", "name": "Rule2", "sendEventsToFMC": false, "ipsPolicy": { "name": "Connectivity Over Security", "id": "IntrusionPolicyUUID", "type": "IntrusionPolicy" }, "originalSourceNetworks": {}, "id": "accessRuleUUID", "vlanTags": { "objects": [ { "type": "VlanTag", "name": "vlan_tag_1", "id": "VlanTagUUID" } ] }, "urls": { "urlCategoriesWithReputation": [ { "type": "UrlCategoryAndReputation", "category": { "name": "Weapons", "id": "URLCategoryUUID", "type": "URLCategory" }, "reputation": "BENIGN_SITES_WITH_SECURITY_RISKS" } ] }, "sourceZones": { "objects": [ { "name": "External", "id": "SecurityZoneUUID", "type": "SecurityZone" } ] }, "destinationZones": { "objects": [ { "name": "Internal", "id": "SecurityZoneUUID", "type": "SecurityZone" } ] }, "logFiles": false, "logBegin": false, "logEnd": false, "variableSet": { "name": "Default Set", "id": "VariableSetUUID", "type": "VariableSet" }, "sourcePorts": { "objects": [ { "type": "ProtocolPortObject", "name": "AOL", "id": "ProtocolPortObjectUUID" } ] }, "destinationPorts": { "objects": [ { "type": "ProtocolPortObject", "name": "Bittorrent", "id": "ProtocolPortObjectUUID" } ] }, "applications": { "applications": [ { "id": "1553", "type": "Application", "name": "1&1 Internet" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/defaultactions": { "get": { "tags": [ "Policy" ], "summary": "getAllDefaultAction", "description": "**Retrieves or modifies the default action associated with the specified access control policy ID and default action ID. If no default action ID is specified, retrieves list of all default actions associated with the specified access control policy ID.**", "operationId": "getAllDefaultAction", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultActionListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/defaultactions/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getDefaultAction", "description": "**Retrieves or modifies the default action associated with the specified access control policy ID and default action ID. If no default action ID is specified, retrieves list of all default actions associated with the specified access control policy ID.**", "operationId": "getDefaultAction", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a default action.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultAction" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updateDefaultAction", "description": "**Retrieves or modifies the default action associated with the specified access control policy ID and default action ID. If no default action ID is specified, retrieves list of all default actions associated with the specified access control policy ID. _Check the response section for applicable examples (if any)._**", "operationId": "updateDefaultAction", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a default action.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input default action model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultAction" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultAction" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/loggingsettings": { "get": { "tags": [ "Policy" ], "summary": "getAllAccessPolicyLoggingSettingModel", "description": "**Retrieves or modifies the logging setting associated with the specified access control policy ID and default action ID. If no default action ID is specified, retrieves list of all default actions associated with the specified access control policy ID.**", "operationId": "getAllAccessPolicyLoggingSettingModel", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessPolicyLoggingSettingModelListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/loggingsettings/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getAccessPolicyLoggingSettingModel", "description": "**Retrieves or modifies the logging setting associated with the specified access control policy ID and default action ID. If no default action ID is specified, retrieves list of all default actions associated with the specified access control policy ID.**", "operationId": "getAccessPolicyLoggingSettingModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a logging setting.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessPolicyLoggingSettingModel" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/domainUuid/policy/accesspolicies/ac_policy_id/loggingsettings?offset=0&limit=1&expanded=true" }, "items": [ { "metadata": { "timestamp": 0 }, "syslogConfigFromPlatformSetting": true, "severityForPlatformSettingSyslogConfig": "CRIT", "syslogConfig": { "name": "test", "id": "8014f0d4-6a33-11e8-8755-90aed85e80f0", "type": "SyslogAlert" }, "enableFileAndMalwareSyslog": true, "fileAndMalwareSyslogSeverity": "ALERT", "fileAndMalwareSyslogConfig": { "name": "test", "id": "3f7ce75e-fd1b-11e8-8a68-ca0898f23acf", "type": "SyslogAlert" }, "type": "LoggingSetting", "id": "005056A9-9F80-0ed3-0000-030064771231" } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updateAccessPolicyLoggingSettingModel", "description": "**Retrieves or modifies the logging setting associated with the specified access control policy ID and default action ID. If no default action ID is specified, retrieves list of all default actions associated with the specified access control policy ID. _Check the response section for applicable examples (if any)._**", "operationId": "updateAccessPolicyLoggingSettingModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a logging setting.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input default action model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessPolicyLoggingSettingModel" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessPolicyLoggingSettingModel" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/operational/hitcounts": { "get": { "tags": [ "Policy" ], "summary": "getHitCount", "description": "**Retrieves, refreshes and clears Hit Count**", "operationId": "getHitCount", "parameters": [ { "name": "filter", "in": "query", "description": "Value is of format (including quotes): \"deviceId:{uuid};ids:{uuid1,uuid2,..};fetchZeroHitCount:{true|false}\"
deviceId is UUID of device and is a mandatory field.
ids returns hitcounts of access rules if set to list of rule UUIDs. If this key is not used, all access rules will be returned (Note that this is applicable only in GET and DELETE operations).
fetchZeroHitCount returns only access rules whose hit count is zero if true (Note that this is applicable only in GET operation and if ids is not used).", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HitCountListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updateHitCount", "description": "**Retrieves, refreshes and clears Hit Count _Check the response section for applicable examples (if any)._**", "operationId": "updateHitCount", "parameters": [ { "name": "filter", "in": "query", "description": "Value is of format (including quotes): \"deviceId:{uuid};ids:{uuid1,uuid2,..};fetchZeroHitCount:{true|false}\"
deviceId is UUID of device and is a mandatory field.
ids returns hitcounts of access rules if set to list of rule UUIDs. If this key is not used, all access rules will be returned (Note that this is applicable only in GET and DELETE operations).
fetchZeroHitCount returns only access rules whose hit count is zero if true (Note that this is applicable only in GET operation and if ids is not used).", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HitCount" }, "example": {} } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Policy" ], "summary": "deleteHitCount", "description": "**Retrieves, refreshes and clears Hit Count _Check the response section for applicable examples (if any)._**", "operationId": "deleteHitCount", "parameters": [ { "name": "filter", "in": "query", "description": "Value is of format (including quotes): \"deviceId:{uuid};ids:{uuid1,uuid2,..};fetchZeroHitCount:{true|false}\"
deviceId is UUID of device and is a mandatory field.
ids returns hitcounts of access rules if set to list of rule UUIDs. If this key is not used, all access rules will be returned (Note that this is applicable only in GET and DELETE operations).
fetchZeroHitCount returns only access rules whose hit count is zero if true (Note that this is applicable only in GET operation and if ids is not used).", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HitCount" }, "example": {} } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getAccessPolicy", "description": "**Retrieves, deletes, creates, or modifies the access control policy associated with the specified ID. Also, retrieves list of all access control policies.**", "operationId": "getAccessPolicy", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for access control policy.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessPolicy" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updateAccessPolicy", "description": "**Retrieves, deletes, creates, or modifies the access control policy associated with the specified ID. Also, retrieves list of all access control policies. _Check the response section for applicable examples (if any)._**", "operationId": "updateAccessPolicy", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for access control policy.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of access control policy.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessPolicy" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessPolicy" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Policy" ], "summary": "deleteAccessPolicy", "description": "**Retrieves, deletes, creates, or modifies the access control policy associated with the specified ID. Also, retrieves list of all access control policies. _Check the response section for applicable examples (if any)._**", "operationId": "deleteAccessPolicy", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for access control policy.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessPolicy" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies": { "get": { "tags": [ "Policy" ], "summary": "getAllFilePolicy", "description": "**Retrieves the endpoint device type object associated with the specified ID. If no ID is specified, retrieves list of all endpoint device type objects.**", "operationId": "getAllFilePolicy", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePolicyListContainer" }, "example": { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/filepolicies?offset=0&limit=2" }, "items": [ { "name": "Test-TestDomain", "id": "File-policy-UUID-1", "type": "FilePolicy", "description": "Test-TestDomain", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/File-policy-UUID-1" }, "metadata": { "readOnly": { "state": true }, "timestamp": 1460056664, "lastUser": { "name": "admin", "id": "User-UUID", "type": "user" }, "domain": { "name": "TestDomain", "id": "domainUUID", "type": "domain" } } }, { "name": "Test-GlobalDomain", "id": "File-policy-UUID-2", "type": "FilePolicy", "description": "Test-GlobalDomain", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/File-policy-UUID-2" }, "metadata": { "readOnly": { "state": false }, "timestamp": 1460057664, "lastUser": { "name": "admin", "id": "User-UUID", "type": "user" }, "domain": { "name": "Global", "id": "Global-domain-UUID", "type": "domain" } } } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getFilePolicy", "description": "**Retrieves the endpoint device type object associated with the specified ID. If no ID is specified, retrieves list of all endpoint device type objects.**", "operationId": "getFilePolicy", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a file policy.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePolicy" }, "example": { "name": "Test-TestDomain", "id": "File-policy-UUID-1", "type": "FilePolicy", "description": "Test-TestDomain", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/File-policy-UUID-1" }, "metadata": { "readOnly": { "state": true }, "timestamp": 1460056664, "lastUser": { "name": "admin", "id": "User-UUID", "type": "user" }, "domain": { "name": "TestDomain", "id": "domainUUID", "type": "domain" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies": { "get": { "tags": [ "Policy" ], "summary": "getAllFTDNatPolicy", "description": "**Retrieves, deletes, creates, or modifies the NAT policy associated with the specified ID. Also, retrieves list of all NAT policies.**", "operationId": "getAllFTDNatPolicy", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDNatPolicyListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Policy" ], "summary": "createFTDNatPolicy", "description": "**Retrieves, deletes, creates, or modifies the NAT policy associated with the specified ID. Also, retrieves list of all NAT policies. _Check the response section for applicable examples (if any)._**", "operationId": "createFTDNatPolicy", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of NAT policy.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDNatPolicy" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDNatPolicy" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/autonatrules": { "get": { "tags": [ "Policy" ], "summary": "getAllFTDAutoNatRule", "description": "**Retrieves, deletes, creates, or modifies the Auto NAT rule associated with the specified ID. Also, retrieves list of all Auto NAT rules. **", "operationId": "getAllFTDAutoNatRule", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDAutoNatRuleListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Policy" ], "summary": "createFTDAutoNatRule", "description": "**Retrieves, deletes, creates, or modifies the Auto NAT rule associated with the specified ID. Also, retrieves list of all Auto NAT rules. _Check the response section for applicable examples (if any)._**", "operationId": "createFTDAutoNatRule", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for auto nat rules.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "section", "in": "query", "description": "Retrieves, creates or modifies auto nat rule in given section. Allowed value is 'auto'.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input Auto NAT rule model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDAutoNatRule" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDAutoNatRule" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/autonatrules/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getFTDAutoNatRule", "description": "**Retrieves, deletes, creates, or modifies the Auto NAT rule associated with the specified ID. Also, retrieves list of all Auto NAT rules. **", "operationId": "getFTDAutoNatRule", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of an Auto NAT rule.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "section", "in": "query", "description": "Retrieves, creates or modifies auto nat rule in given section. Allowed value is 'auto'.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDAutoNatRule" }, "example": { "metadata": { "section": "AUTO", "timestamp": 1489053023583, "domain": { "name": "Global", "id": "domainUuid", "type": "Domain" } }, "links": { "self": "/api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid", "parent": "/api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules" }, "serviceProtocol": "TCP", "translatedNetwork": { "type": "Network", "id": "networkObjUuid", "name": "IPv4-Multicast" }, "translatedPort": 1234, "originalNetwork": { "type": "Network", "id": "networkObjUuid", "name": "IPv4-Link-Local" }, "originalPort": 345, "type": "FTDAutoNatRule", "destinationInterface": { "name": "seczonemanual", "id": "secZoneObjUuid", "type": "SecurityZone" }, "dns": false, "interfaceIpv6": false, "noProxyArp": false, "netToNet": false, "natType": "STATIC", "sourceInterface": { "name": "seczonemanual", "id": "secZoneObjUuid", "type": "SecurityZone" }, "id": "autoNatRuleUuid" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updateFTDAutoNatRule", "description": "**Retrieves, deletes, creates, or modifies the Auto NAT rule associated with the specified ID. Also, retrieves list of all Auto NAT rules. _Check the response section for applicable examples (if any)._**", "operationId": "updateFTDAutoNatRule", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of an Auto NAT rule.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "section", "in": "query", "description": "Retrieves, creates or modifies auto nat rule in given section. Allowed value is 'auto'.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input Auto NAT rule model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDAutoNatRule" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDAutoNatRule" }, "example": { "originalNetwork": { "type": "Network", "id": "Network object uuid" }, "translatedNetwork": { "type": "Network", "id": "Network object uuid" }, "id": "autoNatRuleUuid", "type": "FTDAutoNatRule", "natType": "STATIC", "interfaceIpv6": false, "fallThrough": false, "dns": false, "routeLookup": false, "noProxyArp": false, "netToNet": false, "sourceInterface": { "id": "security zone uuid", "type": "SecurityZone" }, "destinationInterface": { "id": "security zone uuid", "type": "SecurityZone" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Policy" ], "summary": "deleteFTDAutoNatRule", "description": "**Retrieves, deletes, creates, or modifies the Auto NAT rule associated with the specified ID. Also, retrieves list of all Auto NAT rules. _Check the response section for applicable examples (if any)._**", "operationId": "deleteFTDAutoNatRule", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of an Auto NAT rule.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDAutoNatRule" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/manualnatrules": { "get": { "tags": [ "Policy" ], "summary": "getAllFTDManualNatRule", "description": "**Retrieves, deletes, creates, or modifies the Manual NAT rule associated with the specified ID. Also, retrieves list of all Manual NAT rules. **", "operationId": "getAllFTDManualNatRule", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDManualNatRuleListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Policy" ], "summary": "createFTDManualNatRule", "description": "**Retrieves, deletes, creates, or modifies the Manual NAT rule associated with the specified ID. Also, retrieves list of all Manual NAT rules. _Check the response section for applicable examples (if any)._**", "operationId": "createFTDManualNatRule", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for manual nat rules.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "section", "in": "query", "description": "Retrieves, creates or modifies manual nat rule in given section. Allowed value is 'before_auto' and 'after_auto'.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "targetIndex", "in": "query", "description": "Creates or modifies manual nat rule at given targetIndex. It takes an integer value.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input Manual NAT rule model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDManualNatRule" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDManualNatRule" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/manualnatrules/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getFTDManualNatRule", "description": "**Retrieves, deletes, creates, or modifies the Manual NAT rule associated with the specified ID. Also, retrieves list of all Manual NAT rules. **", "operationId": "getFTDManualNatRule", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a Manual NAT rule.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "section", "in": "query", "description": "Retrieves, creates or modifies manual nat rule in given section. Allowed value is 'before_auto' and 'after_auto'.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDManualNatRule" }, "example": { "metadata": { "section": "BEFORE_AUTO", "index": -1, "timestamp": 1488950245960, "domain": { "name": "Global", "id": "domainUuid", "type": "Domain" } }, "links": { "self": "/api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/manualnatrules/manualNatRuleUuid1", "parent": "/api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules" }, "unidirectional": true, "originalSource": { "type": "Network", "id": "networkObjUuid", "name": "any" }, "interfaceInOriginalDestination": false, "interfaceInTranslatedSource": true, "enabled": true, "type": "FTDManualNatRule", "destinationInterface": { "name": "seczonemanual", "id": "secZoneObjUuid2", "type": "SecurityZone" }, "dns": false, "interfaceIpv6": false, "noProxyArp": false, "netToNet": false, "natType": "DYNAMIC", "sourceInterface": { "name": "seczonebefore", "id": "secZoneObjUuid", "type": "SecurityZone" }, "id": "manualNatRuleUuid1" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updateFTDManualNatRule", "description": "**Retrieves, deletes, creates, or modifies the Manual NAT rule associated with the specified ID. Also, retrieves list of all Manual NAT rules. _Check the response section for applicable examples (if any)._**", "operationId": "updateFTDManualNatRule", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a Manual NAT rule.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "section", "in": "query", "description": "Retrieves, creates or modifies manual nat rule in given section. Allowed value is 'before_auto' and 'after_auto'.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "targetIndex", "in": "query", "description": "Creates or modifies manual nat rule at given targetIndex. It takes an integer value.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input Manual NAT rule model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDManualNatRule" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDManualNatRule" }, "example": { "originalDestinationPort": { "type": "ProtocolPortObject", "id": "protocol port object uuid" }, "originalSource": { "type": "Network", "id": "Network object uuid" }, "originalSourcePort": { "type": "ProtocolPortObject", "id": "protocol port object uuid" }, "translatedDestination": { "type": "Network", "id": "Network object uuid" }, "translatedDestinationPort": { "type": "ProtocolPortObject", "id": "protocol port object uuid" }, "translatedSource": { "type": "Network", "id": "network object uuid" }, "translatedSourcePort": { "type": "ProtocolPortObject", "id": "protocol port object uuid" }, "unidirectional": false, "originalDestination": { "type": "Network", "id": "network object uuid" }, "id": "manualNatRuleUuid", "interfaceInOriginalDestination": false, "type": "FTDManualNatRule", "enabled": true, "natType": "STATIC", "interfaceIpv6": false, "fallThrough": false, "dns": false, "routeLookup": false, "noProxyArp": false, "netToNet": false, "sourceInterface": { "id": "security zone uuid", "type": "SecurityZone" }, "destinationInterface": { "id": "security zone uuid", "type": "SecurityZone" }, "description": "description of nat rule" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Policy" ], "summary": "deleteFTDManualNatRule", "description": "**Retrieves, deletes, creates, or modifies the Manual NAT rule associated with the specified ID. Also, retrieves list of all Manual NAT rules. _Check the response section for applicable examples (if any)._**", "operationId": "deleteFTDManualNatRule", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a Manual NAT rule.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDManualNatRule" }, "example": { "metadata": { "section": "BEFORE_AUTO", "index": 0, "timestamp": 1493371106718, "domain": { "name": "Global", "id": "global_domain_uuid", "type": "Domain" } }, "links": { "self": "/api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/manualnatrules/manualNatRuleUuid", "parent": "/api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules" }, "id": "manualNatRuleUuid", "originalDestinationPort": { "type": "ProtocolPortObject", "id": "protocol port object uuid", "name": "port object name" }, "originalSource": { "type": "Network", "id": "network object uuid", "name": "network object name" }, "originalSourcePort": { "type": "ProtocolPortObject", "id": "protocol port object uuid", "name": "port object name" }, "translatedDestination": { "type": "Network", "id": "network object uuid", "name": "network object name" }, "translatedDestinationPort": { "type": "ProtocolPortObject", "id": "protocol port object uuid", "name": "port object name" }, "translatedSource": { "type": "Network", "id": "network object uuid", "name": "network object name" }, "patOptions": { "patPoolAddress": { "type": "Host", "id": "Host object uuid", "name": "NW1" }, "interfacePat": false, "includeReserve": true, "roundRobin": true, "extendedPat": true, "flatPortRange": true }, "unidirectional": false, "originalDestination": { "type": "Network", "id": "network object uuid", "name": "network object name" }, "interfaceInOriginalDestination": false, "type": "FTDManualNatRule", "enabled": true, "natType": "STATIC", "interfaceIpv6": false, "fallThrough": false, "dns": false, "routeLookup": false, "noProxyArp": false, "netToNet": false, "sourceInterface": { "name": "sec zone object name", "id": "security zone uuid", "type": "SecurityZone" }, "destinationInterface": { "name": "sec zone object name", "id": "sec zone object uuid", "type": "SecurityZone" }, "description": "description of nat rule" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/natrules": { "get": { "tags": [ "Policy" ], "summary": "getAllFTDNatRule", "description": "**Retrieves list of all NAT rules (manual and auto) associated with the specified policy ID.**", "operationId": "getAllFTDNatRule", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDNatRuleListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/natrules/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getFTDNatRule", "description": "**Retrieves list of all NAT rules (manual and auto) associated with the specified policy ID.**", "operationId": "getFTDNatRule", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a NAT rule.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "section", "in": "query", "description": "Retrieves nat rule in given section. Allowed value is 'before_auto', 'auto' and 'after_auto'.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDNatRule" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getFTDNatPolicy", "description": "**Retrieves, deletes, creates, or modifies the NAT policy associated with the specified ID. Also, retrieves list of all NAT policies.**", "operationId": "getFTDNatPolicy", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for NAT policy.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDNatPolicy" }, "example": { "type": "FTDNatPolicy", "links": { "self": "/api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies/natPolUuid1" }, "rules": { "refType": "list", "links": { "self": "/api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies/natPolUuid1/natrules" } }, "name": "NatPol", "description": "nat policy for testing", "id": "natPolUuid1" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updateFTDNatPolicy", "description": "**Retrieves, deletes, creates, or modifies the NAT policy associated with the specified ID. Also, retrieves list of all NAT policies. _Check the response section for applicable examples (if any)._**", "operationId": "updateFTDNatPolicy", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for NAT policy.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of NAT policy.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDNatPolicy" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDNatPolicy" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Policy" ], "summary": "deleteFTDNatPolicy", "description": "**Retrieves, deletes, creates, or modifies the NAT policy associated with the specified ID. Also, retrieves list of all NAT policies. _Check the response section for applicable examples (if any)._**", "operationId": "deleteFTDNatPolicy", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for NAT policy.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDNatPolicy" }, "example": { "type": "FTDNatPolicy", "links": { "self": "/api/fmc_config/v1/domain/domainUUID/policy/natpolicies/natPolicyUuid" }, "rules": { "refType": "list", "links": { "self": "/api/fmc_config/v1/domain/domainUUID/policy/natpolicies/natPolicyUuid/natrules" } }, "name": "UpdatedNatPolName", "description": "Updated description", "id": "natPolicyUuid" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns": { "get": { "tags": [ "Policy" ], "summary": "getAllFTDS2SVpnModel", "description": "**Retrieves, deletes, creates, or modifies the FTD Site to Site VPN topology associated with the specified ID. If no ID is specified for a GET, retrieves list of all FTD Site to Site VPN topologies.**", "operationId": "getAllFTDS2SVpnModel", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDS2SVpnModelListContainer" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns?offset=0&limit=1&expanded=true" }, "items": [ { "name": "cisco_s2s_vpn", "id": "005056A9-9F80-0ed3-0000-008589935105", "type": "FTDS2SVpn", "topologyType": "POINT_TO_POINT", "ikeV1Enabled": false, "ikeV2Enabled": true, "links": { "self": "/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-9F80-0ed3-0000-008589935105" }, "endpoints": { "refType": "list", "links": { "self": "/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-9F80-0ed3-0000-008589935105/endpoints" }, "type": "EndPoint" }, "ikeSettings": { "links": { "self": "/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-9F80-0ed3-0000-008589935105/ikesettings/005056A9-7483-0ed3-0000-012884902862" }, "id": "005056A9-7483-0ed3-0000-012884902862", "type": "IkeSettings" }, "ipsecSettings": { "id": "005056A9-9F80-0ed3-0000-008589935150", "type": "IPSecSettings", "links": { "self": "/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-9F80-0ed3-0000-008589935105/ipsecsettings/005056A9-9F80-0ed3-0000-008589935150" } }, "advancedSettings": { "id": "005056A9-9F80-0ed3-0000-008589935160", "type": "AdvancedSettings", "links": { "self": "/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-9F80-0ed3-0000-008589935105/advancedSettings/005056A9-9F80-0ed3-0000-008589935160" } }, "metadata": { "timestamp": 1527842213894, "lastUser": { "name": "admin" }, "domain": { "name": "Global", "id": "e276abec-e0f2-11e3-8169-6d9ed49b625f" } } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Policy" ], "summary": "createFTDS2SVpnModel", "description": "**Retrieves, deletes, creates, or modifies the FTD Site to Site VPN topology associated with the specified ID. If no ID is specified for a GET, retrieves list of all FTD Site to Site VPN topologies. _Check the response section for applicable examples (if any)._**", "operationId": "createFTDS2SVpnModel", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of FTD Site to Site VPN topology.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDS2SVpnModel" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDS2SVpnModel" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/advancedsettings": { "get": { "tags": [ "Policy" ], "summary": "getAllVpnAdvancedSettings", "description": "**Retrieves and modifies a Advanced settings inside a VPN Site To Site Topology. If no ID is specified for a GET, retrieves list containing a single AdvancedSettings entry of the topology.**", "operationId": "getAllVpnAdvancedSettings", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnAdvancedSettingsListContainer" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-097E-0ed3-0000-008589935150/advancedsettings?offset=0&limit=1&expanded=true" }, "items": [ { "id": "005056A9-097E-0ed3-0000-021474836554", "type": "AdvancedSettings", "links": { "self": "/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-097E-0ed3-0000-008589935150/advancedsettings/005056A9-097E-0ed3-0000-021474836554" }, "advancedIkeSetting": { "peerIdentityValidation": "REQUIRED", "thresholdToChallengeIncomingCookies": 50, "percentageOfSAsAllowedInNegotiation": 100, "enableNotificationOnTunnelDisconnect": false, "identitySentToPeer": "AUTO_OR_DN", "enableAggressiveMode": false, "cookieChallenge": "CUSTOM" }, "advancedTunnelSetting": { "certificateMapSettings": { "useCertMapConfiguredInEndpointToDetermineTunnel": false, "useCertificateOuToDetermineTunnel": true, "useIkeIdentityOuToDetermineTunnel": true, "usePeerIpAddressToDetermineTunnel": true }, "enableSpokeToSpokeConnectivityThrougHub": false, "natKeepaliveMessageTraversal": { "enabled": true, "intervalSeconds": 20 }, "bypassAccessControlTrafficForDecryptedTraffic": false }, "advancedIpsecSetting": { "maximumTransmissionUnitAging": { "enabled": false }, "enableFragmentationBeforeEncryption": true } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/advancedsettings/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getVpnAdvancedSettings", "description": "**Retrieves and modifies a Advanced settings inside a VPN Site To Site Topology. If no ID is specified for a GET, retrieves list containing a single AdvancedSettings entry of the topology.**", "operationId": "getVpnAdvancedSettings", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for Advanced settings in a Site to Site VPN topology.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnAdvancedSettings" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updateVpnAdvancedSettings", "description": "**Retrieves and modifies a Advanced settings inside a VPN Site To Site Topology. If no ID is specified for a GET, retrieves list containing a single AdvancedSettings entry of the topology. _Check the response section for applicable examples (if any)._**", "operationId": "updateVpnAdvancedSettings", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for Advanced settings in a Site to Site VPN topology.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of Advanced settings in a Site to Site VPN topology.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnAdvancedSettings" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnAdvancedSettings" }, "example": { "id": "005056A9-097E-0ed3-0000-021474836554", "type": "AdvancedSettings", "links": { "self": "/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-097E-0ed3-0000-008589935150/advancedsettings/005056A9-097E-0ed3-0000-021474836554" }, "advancedIkeSetting": { "peerIdentityValidation": "REQUIRED", "thresholdToChallengeIncomingCookies": 50, "percentageOfSAsAllowedInNegotiation": 100, "enableNotificationOnTunnelDisconnect": false, "identitySentToPeer": "AUTO_OR_DN", "enableAggressiveMode": false, "cookieChallenge": "CUSTOM" }, "advancedTunnelSetting": { "certificateMapSettings": { "useCertMapConfiguredInEndpointToDetermineTunnel": false, "useCertificateOuToDetermineTunnel": true, "useIkeIdentityOuToDetermineTunnel": true, "usePeerIpAddressToDetermineTunnel": true }, "enableSpokeToSpokeConnectivityThroughHub": false, "natKeepaliveMessageTraversal": { "enabled": true, "intervalSeconds": 20 }, "bypassAccessControlTrafficForDecryptedTraffic": false }, "advancedIpsecSetting": { "maximumTransmissionUnitAging": { "enabled": false }, "enableFragmentationBeforeEncryption": true } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/endpoints": { "get": { "tags": [ "Policy" ], "summary": "getAllVpnEndpoint", "description": "**Retrieves, deletes, creates, or modifies a specific Endpoint associated with the specified ID inside a VPN Site To Site Topology. If no ID is specifid for a GET, retrieves list of all Endpoints of a topology.**", "operationId": "getAllVpnEndpoint", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnEndpointListContainer" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/domainUUID/policy/ftds2svpns/topologyUuid/endpoints?offset=0&limit=2&expanded=true" }, "items": [ { "links": { "self": "/api/fmc_config/v1/domain/domainUUID/policy/ftds2svpns/topologyUuid/endpoints/005056A9-6FFE-0ed3-0000-120259084433" }, "name": "192.168.0.22", "id": "005056A9-6FFE-0ed3-0000-120259084433", "type": "EndPoint", "extranet": false, "device": { "name": "192.168.0.22", "id": "463b5424-2812-11e8-9a5f-89adee70d40d", "type": "Device" }, "interface": { "name": "s1", "id": "005056A9-6FFE-0ed3-0000-042949673272" }, "protectedNetworks": { "networks": [ { "name": "IPv4-Private-172.16.0.0-12", "id": "b7a78a7d-20c5-47b2-b02f-86b4360112ac" } ] }, "connectionType": "BIDIRECTIONAL", "peerType": "PEER" }, { "links": { "self": "/api/fmc_config/v1/domain/domainUUID/policy/ftds2svpns/topologyUuid/endpoints/endpointId" }, "interface": { "name": "inside", "id": "005056A9-6FFE-0ed3-0000-004294967551" }, "name": "192.168.0.22", "id": "endpointId", "type": "EndPoint", "extranet": false, "device": { "name": "192.168.0.22", "id": "463b5424-2812-11e8-9a5f-89adee70d40d", "type": "Device" }, "connectionType": "ORIGINATE_ONLY", "protectedNetworks": { "networks": [ { "name": "IPv4-Private-172.16.0.0-12", "id": "b7a78a7d-20c5-47b2-b02f-86b4360112ac" } ] }, "peerType": "PEER" } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Policy" ], "summary": "createVpnEndpoint", "description": "**Retrieves, deletes, creates, or modifies a specific Endpoint associated with the specified ID inside a VPN Site To Site Topology. If no ID is specifid for a GET, retrieves list of all Endpoints of a topology. _Check the response section for applicable examples (if any)._**", "operationId": "createVpnEndpoint", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of Endpoint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnEndpoint" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnEndpoint" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/endpoints/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getVpnEndpoint", "description": "**Retrieves, deletes, creates, or modifies a specific Endpoint associated with the specified ID inside a VPN Site To Site Topology. If no ID is specifid for a GET, retrieves list of all Endpoints of a topology.**", "operationId": "getVpnEndpoint", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for an Endpoint in a Site to Site VPN topology.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnEndpoint" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updateVpnEndpoint", "description": "**Retrieves, deletes, creates, or modifies a specific Endpoint associated with the specified ID inside a VPN Site To Site Topology. If no ID is specifid for a GET, retrieves list of all Endpoints of a topology. _Check the response section for applicable examples (if any)._**", "operationId": "updateVpnEndpoint", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for an Endpoint in a Site to Site VPN topology.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of Endpoint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnEndpoint" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnEndpoint" }, "example": { "id": "005056A9-6FFE-0ed3-0000-120259084433", "type": "EndPoint", "extranet": false, "device": { "name": "192.168.0.22", "id": "463b5424-2812-11e8-9a5f-89adee70d40d", "type": "Device" }, "interface": { "name": "s1", "id": "005056A9-6FFE-0ed3-0000-042949673272" }, "connectionType": "BIDIRECTIONAL", "protectedNetworks": { "networks": [ { "name": "IPv4-Private-172.16.0.0-12", "id": "b7a78a7d-20c5-47b2-b02f-86b4360112ac" } ] }, "peerType": "PEER" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Policy" ], "summary": "deleteVpnEndpoint", "description": "**Retrieves, deletes, creates, or modifies a specific Endpoint associated with the specified ID inside a VPN Site To Site Topology. If no ID is specifid for a GET, retrieves list of all Endpoints of a topology. _Check the response section for applicable examples (if any)._**", "operationId": "deleteVpnEndpoint", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for an Endpoint in a Site to Site VPN topology.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnEndpoint" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/ikesettings": { "get": { "tags": [ "Policy" ], "summary": "getAllVpnIkeSettings", "description": "**Retrieves, deletes, creates, or modifies the IKE Settings associated with the specified ID inside a VPN Site To Site Topology. If no ID is specified for a GET, retrieves Ike Settings of a topology.**", "operationId": "getAllVpnIkeSettings", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnIkeSettingsListContainer" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/domainUUID/policy/ftds2svpns/topologyUUID/ikesettings?offset=0&limit=1" }, "items": [ { "links": { "self": "/api/fmc_config/v1/domain/domainUUID/policy/ftds2svpns/topologyUUID/ikesettings/005056A9-7483-0ed3-0000-012884902862" }, "id": "005056A9-7483-0ed3-0000-012884902862", "type": "IkeSettings" } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/ikesettings/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getVpnIkeSettings", "description": "**Retrieves, deletes, creates, or modifies the IKE Settings associated with the specified ID inside a VPN Site To Site Topology. If no ID is specified for a GET, retrieves Ike Settings of a topology.**", "operationId": "getVpnIkeSettings", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for an Ike Settings policy in a Site to Site VPN topology.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnIkeSettings" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updateVpnIkeSettings", "description": "**Retrieves, deletes, creates, or modifies the IKE Settings associated with the specified ID inside a VPN Site To Site Topology. If no ID is specified for a GET, retrieves Ike Settings of a topology. _Check the response section for applicable examples (if any)._**", "operationId": "updateVpnIkeSettings", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for an Ike Settings policy in a Site to Site VPN topology.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of Ike Settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnIkeSettings" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnIkeSettings" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/domainUUID/policy/ftds2svpns/topologyUUID/ikesettings/005056A9-7483-0ed3-0000-012884902862" }, "id": "005056A9-7483-0ed3-0000-012884902862", "type": "IkeSettings", "ikeV2Settings": { "automaticPreSharedKeyLength": 7, "enforceHexBasedPreSharedKeyOnly": true, "authenticationType": "AUTOMATIC_PRE_SHARED_KEY", "policy": { "name": "DES-SHA-SHA", "id": "005056A9-6FFE-0ed3-0000-000000000402", "type": "Ike2" } }, "ikeV1Settings": { "automaticPreSharedKeyLength": 7, "authenticationType": "AUTOMATIC_PRE_SHARED_KEY", "policy": { "name": "preshared_sha_des_dh5_160", "id": "005056A9-6FFE-0ed3-0000-000000000303", "type": "Ike" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/ipsecsettings": { "get": { "tags": [ "Policy" ], "summary": "getAllVpnIPSecSettings", "description": "**Retrieves and modifies a IPSec Proposal settings inside a VPN Site To Site Topology. If no ID is specified for a GET, retrieves list containing a single IPSecSettings entry of the topology.**", "operationId": "getAllVpnIPSecSettings", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnIPSecSettingsListContainer" }, "example": { "links": { "self": "https://u32c01p12-vrouter.cisco.com:8131/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-302C-0ed3-0000-017179869721/ipsecsettings?offset=0&limit=1" }, "items": [ { "id": "005056A9-302C-0ed3-0000-038654705756", "type": "IPSecSettings", "links": { "self": "https://u32c01p12-vrouter.cisco.com:8131/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-302C-0ed3-0000-017179869721/ipsecsettings/005056A9-302C-0ed3-0000-038654705756" } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/ipsecsettings/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getVpnIPSecSettings", "description": "**Retrieves and modifies a IPSec Proposal settings inside a VPN Site To Site Topology. If no ID is specified for a GET, retrieves list containing a single IPSecSettings entry of the topology.**", "operationId": "getVpnIPSecSettings", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for IPSec Proposal settings in a Site to Site VPN topology.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnIPSecSettings" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updateVpnIPSecSettings", "description": "**Retrieves and modifies a IPSec Proposal settings inside a VPN Site To Site Topology. If no ID is specified for a GET, retrieves list containing a single IPSecSettings entry of the topology. _Check the response section for applicable examples (if any)._**", "operationId": "updateVpnIPSecSettings", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for IPSec Proposal settings in a Site to Site VPN topology.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of IPSec Proposal settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnIPSecSettings" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnIPSecSettings" }, "example": { "tfcPackets": { "enabled": false, "burstBytes": 0, "payloadBytes": 0, "timeoutSeconds": 0 }, "cryptoMapType": "STATIC", "ikeV2Mode": "TUNNEL", "enableSaStrengthEnforcement": false, "enableRRI": true, "lifetimeSeconds": 28800, "lifetimeKilobytes": 4608000, "perfectForwardSecrecy": { "enabled": false }, "validateIncomingIcmpErrorMessage": false, "doNotFragmentPolicy": "NONE", "id": "005056A9-302C-0ed3-0000-017179869924", "type": "IPSecSettings", "links": { "self": "https://u32c01p12-vrouter.cisco.com:8131/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-302C-0ed3-0000-017179869721/ipsecsettings/005056A9-302C-0ed3-0000-017179869924" }, "ikeV2IpsecProposal": [ { "name": "AES-GCM", "id": "005056A9-302C-0ed3-0000-000000002010", "type": "IKEv2IPsecProposal" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getFTDS2SVpnModel", "description": "**Retrieves, deletes, creates, or modifies the FTD Site to Site VPN topology associated with the specified ID. If no ID is specified for a GET, retrieves list of all FTD Site to Site VPN topologies.**", "operationId": "getFTDS2SVpnModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for FTD Site to Site VPN topology.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDS2SVpnModel" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updateFTDS2SVpnModel", "description": "**Retrieves, deletes, creates, or modifies the FTD Site to Site VPN topology associated with the specified ID. If no ID is specified for a GET, retrieves list of all FTD Site to Site VPN topologies. _Check the response section for applicable examples (if any)._**", "operationId": "updateFTDS2SVpnModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for FTD Site to Site VPN topology.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of FTD Site to Site VPN topology.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDS2SVpnModel" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDS2SVpnModel" }, "example": { "name": "Cicso_S2S_Vpn", "type": "FTDS2SVpn", "topologyType": "POINT_TO_POINT", "ikeV1Enabled": true, "ikeV2Enabled": false } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Policy" ], "summary": "deleteFTDS2SVpnModel", "description": "**Retrieves, deletes, creates, or modifies the FTD Site to Site VPN topology associated with the specified ID. If no ID is specified for a GET, retrieves list of all FTD Site to Site VPN topologies. _Check the response section for applicable examples (if any)._**", "operationId": "deleteFTDS2SVpnModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for FTD Site to Site VPN topology.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FTDS2SVpnModel" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-7483-0ed3-0000-012884902862" }, "ipsecSettings": { "id": "005056A9-5800-0ed3-0000-008589935770", "type": "ipsecsettings", "links": { "self": "/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-5800-0ed3-0000-008589935597/ipsecsettings/005056A9-5800-0ed3-0000-008589935770" } }, "endpoints": { "refType": "list", "type": "EndPoint", "links": { "self": "/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-5800-0ed3-0000-008589935597/endpoints" } }, "ikeSettings": { "links": { "self": "/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-5800-0ed3-0000-008589935597/ikesettings" }, "id": "005056A9-7483-0ed3-0000-012884902862", "type": "IkeSettings" }, "topologyType": "POINT_TO_POINT", "ikeV1Enabled": false, "ikeV2Enabled": true, "name": "tests2s", "id": "005056A9-5800-0ed3-0000-008589935597", "type": "FTDS2SVpn" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies": { "get": { "tags": [ "Policy" ], "summary": "getAllIntrusionPolicy", "description": "**Retrieves the intrusion policy associated with the specified ID. If no ID is specified, retrieves list of all intrusion policies.**", "operationId": "getAllIntrusionPolicy", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntrusionPolicyListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/policy/intrusionpolicies?offset=0&limit=5" }, "items": [ { "name": "No Rules Active", "id": "intrusionPolicyUUID", "links": { "self": "/fmc_config/v1/domain/DomainUUID/policy/intrusionpolicies/intrusionPolicyUUID" }, "type": "IntrusionPolicy" }, { "name": "Maximum Detection", "id": "intrusionPolicyUUID", "links": { "self": "/fmc_config/v1/domain/DomainUUID/policy/intrusionpolicies/intrusionPolicyUUID" }, "type": "IntrusionPolicy" }, { "name": "Connectivity Over Security", "id": "intrusionPolicyUUID", "links": { "self": "/fmc_config/v1/domain/DomainUUID/policy/intrusionpolicies/intrusionPolicyUUID" }, "type": "IntrusionPolicy" }, { "name": "Balanced Security and Connectivity", "id": "intrusionPolicyUUID", "links": { "self": "/fmc_config/v1/domain/DomainUUID/policy/intrusionpolicies/intrusionPolicyUUID" }, "type": "IntrusionPolicy" }, { "name": "Security Over Connectivity", "id": "intrusionPolicyUUID", "links": { "self": "/fmc_config/v1/domain/DomainUUID/policy/intrusionpolicies/intrusionPolicyUUID" }, "type": "IntrusionPolicy" } ], "paging": { "offset": 0, "limit": 5, "count": 5, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getIntrusionPolicy", "description": "**Retrieves the intrusion policy associated with the specified ID. If no ID is specified, retrieves list of all intrusion policies.**", "operationId": "getIntrusionPolicy", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for intrusion policy.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntrusionPolicy" }, "example": { "name": "Security Over Connectivity", "id": "intrusionPolicyUUID", "links": { "self": "/fmc_config/v1/domain/DomainUUID/policy/intrusionpolicies/intrusionPolicyUUID" }, "type": "IntrusionPolicy", "metadata": { "readOnly": { "state": true }, "domain": { "id": "DomainUUID", "type": "Domain", "name": "Global" }, "lastUser": { "name": "admin", "id": "userUUID", "type": "User" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies": { "get": { "tags": [ "Policy" ], "summary": "getAllPrefilterPolicy", "description": "**Retrieves prefilter policy associated with the specified ID. Also, retrieves list of all prefilter policies.**", "operationId": "getAllPrefilterPolicy", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrefilterPolicyListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/operational/hitcounts": { "get": { "tags": [ "Policy" ], "summary": "getPrefilterHitCount", "description": "**Retrieves, refreshes and clears Hit Count**", "operationId": "getPrefilterHitCount", "parameters": [ { "name": "filter", "in": "query", "description": "Value is of format (including quotes): \"deviceId:{uuid};ids:{uuid1,uuid2,..};fetchZeroHitCount:{true|false}\"
deviceId is UUID of device and is a mandatory field.
ids returns hitcounts of prefilter rules if set to list of rule UUIDs. If this key is not used, all prefilter rules will be returned (Note that this is applicable only in GET and DELETE operations).
fetchZeroHitCount returns only access rules whose hit count is zero if true (Note that this is applicable only in GET operation and if ids is not used).", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrefilterHitCountListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Policy" ], "summary": "updatePrefilterHitCount", "description": "**Retrieves, refreshes and clears Hit Count _Check the response section for applicable examples (if any)._**", "operationId": "updatePrefilterHitCount", "parameters": [ { "name": "filter", "in": "query", "description": "Value is of format (including quotes): \"deviceId:{uuid};ids:{uuid1,uuid2,..};fetchZeroHitCount:{true|false}\"
deviceId is UUID of device and is a mandatory field.
ids returns hitcounts of prefilter rules if set to list of rule UUIDs. If this key is not used, all prefilter rules will be returned (Note that this is applicable only in GET and DELETE operations).
fetchZeroHitCount returns only access rules whose hit count is zero if true (Note that this is applicable only in GET operation and if ids is not used).", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrefilterHitCount" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Policy" ], "summary": "deletePrefilterHitCount", "description": "**Retrieves, refreshes and clears Hit Count _Check the response section for applicable examples (if any)._**", "operationId": "deletePrefilterHitCount", "parameters": [ { "name": "filter", "in": "query", "description": "Value is of format (including quotes): \"deviceId:{uuid};ids:{uuid1,uuid2,..};fetchZeroHitCount:{true|false}\"
deviceId is UUID of device and is a mandatory field.
ids returns hitcounts of prefilter rules if set to list of rule UUIDs. If this key is not used, all prefilter rules will be returned (Note that this is applicable only in GET and DELETE operations).
fetchZeroHitCount returns only access rules whose hit count is zero if true (Note that this is applicable only in GET operation and if ids is not used).", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrefilterHitCount" }, "example": {} } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getPrefilterPolicy", "description": "**Retrieves prefilter policy associated with the specified ID. Also, retrieves list of all prefilter policies.**", "operationId": "getPrefilterPolicy", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for prefilter policy.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrefilterPolicy" }, "example": { "type": "PrefilterPolicy", "name": "PrefilterPolicy_01", "id": "String", "description": "policy to test FMC implementation" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/snmpalerts": { "get": { "tags": [ "Policy" ], "summary": "getAllSNMPConfig", "description": "**Retrieves the SNMP alert object associated with the specified ID. If no ID is specified, retrieves list of all SNMP alert objects.**", "operationId": "getAllSNMPConfig", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SNMPConfigListContainer" }, "example": { "links": { "self": "https://somehost.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/snmpalerts?offset=0&limit=3" }, "items": [ { "name": "Test-SNMP-Global-v2", "id": "SNMP-alert-UUID-1", "type": "SNMPAlert", "version": "2.0", "links": { "self": "https://somehost.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/snmpalerts/SNMP-alert-UUID-1" }, "metadata": { "readOnly": { "state": false }, "timestamp": 1460056664, "lastUser": { "name": "admin", "id": "User-UUID", "type": "user" }, "domain": { "name": "Global", "id": "Global-domain-UUID", "type": "domain" } } }, { "name": "Test-SNMP-TestDomain-v1", "id": "SNMP-alert-UUID-2", "type": "SNMPAlert", "version": "1.0", "links": { "self": "https://somehost.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/snmpalerts/SNMP-alert-UUID-2" }, "metadata": { "readOnly": { "state": true }, "timestamp": 1460057664, "lastUser": { "name": "admin", "id": "User-UUID", "type": "user" }, "domain": { "name": "TestDomain", "id": "domainUUID", "type": "domain" } } }, { "name": "Test-SNMP-TestDomain-v3", "id": "SNMP-alert-UUID-3", "type": "SNMPAlert", "version": "3.0", "links": { "self": "https://somehost.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/snmpalerts/SNMP-alert-UUID-3" }, "metadata": { "readOnly": { "state": true }, "timestamp": 1460058664, "lastUser": { "name": "admin", "id": "User-UUID", "type": "user" }, "domain": { "name": "TestDomain", "id": "domainUUID", "type": "domain" } } } ], "paging": { "offset": 0, "limit": 3, "count": 3, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/snmpalerts/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getSNMPConfig", "description": "**Retrieves the SNMP alert object associated with the specified ID. If no ID is specified, retrieves list of all SNMP alert objects.**", "operationId": "getSNMPConfig", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a SNMP alert.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SNMPConfig" }, "example": { "name": "Test-SNMP-Global-v2", "id": "SNMP-alert-UUID-1", "type": "SNMPAlert", "version": "2.0", "links": { "self": "https://somehost.cisco.com/api/fmc_config/v1/domain/default/policy/snmpalerts/SNMP-alert-UUID-1" }, "metadata": { "readOnly": { "state": true }, "timestamp": 1460056664, "lastUser": { "name": "admin", "id": "User-UUID", "type": "user" }, "domain": { "name": "Global", "id": "Global-domain-UUID", "type": "domain" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/syslogalerts": { "get": { "tags": [ "Policy" ], "summary": "getAllSyslogConfig", "description": "**Retrieves the syslog alert object associated with the specified ID. If no ID is specified, retrieves list of all syslog alert objects.**", "operationId": "getAllSyslogConfig", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyslogConfigListContainer" }, "example": { "links": { "self": "https://somehost.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/syslogalerts?offset=0&limit=2" }, "items": [ { "name": "Test-Syslog-Global", "id": "Syslog-alert-UUID-1", "type": "SyslogAlert", "links": { "self": "https://somehost.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/syslogalerts/Syslog-alert-UUID-1" } }, { "name": "Test-Syslog-Testdomain", "id": "Syslog-alert-UUID-2", "type": "SyslogAlert", "links": { "self": "https://somehost.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/syslogalerts/Syslog-alert-UUID-2" } } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/policy/syslogalerts/{objectId}": { "get": { "tags": [ "Policy" ], "summary": "getSyslogConfig", "description": "**Retrieves the syslog alert object associated with the specified ID. If no ID is specified, retrieves list of all syslog alert objects.**", "operationId": "getSyslogConfig", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a syslog alert.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyslogConfig" }, "example": { "name": "Test-Syslog-Global", "id": "Syslog-alert-UUID-1", "type": "SyslogAlert", "links": { "self": "https://somehost.cisco.com/api/fmc_config/v1/domain/default/policy/syslogalerts/Syslog-alert-UUID-1" }, "metadata": { "readOnly": { "state": true }, "timestamp": 1460056577, "lastUser": { "name": "admin", "id": "User-UUID", "type": "user" }, "domain": { "name": "Global", "id": "Global-domain-UUID", "type": "domain" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/anyprotocolportobjects": { "get": { "tags": [ "Object" ], "summary": "getAllAnyProtocolPortObject", "description": "**Retrieves, deletes, creates, or modifies the any protocol port object associated with the specified ID. If no ID is specified for a GET, retrieves list of all any protocol port objects (all port objects with a protocol value of All).**", "operationId": "getAllAnyProtocolPortObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnyProtocolPortObjectListContainer" }, "example": { "links": { "self": "https://fmc_host_ip/api/fmc_config/v1/domain/global/object/anyprotocolportobjects/anyProtocolPortObjUUID", "parent": "https://fmc_host_ip/api/fmc_config/v1/domain/global/object/ports" }, "type": "AnyProtocolPortObject", "name": "myAny", "description": " ", "id": "anyProtocolPortObjUUID" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/anyprotocolportobjects/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getAnyProtocolPortObject", "description": "**Retrieves, deletes, creates, or modifies the any protocol port object associated with the specified ID. If no ID is specified for a GET, retrieves list of all any protocol port objects (all port objects with a protocol value of All).**", "operationId": "getAnyProtocolPortObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnyProtocolPortObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/applicationcategories": { "get": { "tags": [ "Object" ], "summary": "getAllApplicationCategory", "description": "**Retrieves the application category object associated with the specified ID. If no ID is specified, retrieves list of all application category objects.**", "operationId": "getAllApplicationCategory", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationCategoryListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationcategories?offset=0&limit=2" }, "items": [ { "type": "ApplicationCategory", "id": "2325", "name": "Low", "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationcategories/2325" } }, { "type": "ApplicationCategory", "id": "1234", "name": "Medium", "links": { "self": "/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/applicationcategories/1234" } } ], "paging": { "offset": 0, "limit": 2, "count": 5, "next": [ "/fmc_config/v1/domain/domainUUID/object/applicationcategories?offset=2&limit=2", "/fmc_config/v1/domain/domainUUID/object/applicationcategories?offset=4&limit=1" ], "pages": 3 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/applicationcategories/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getApplicationCategory", "description": "**Retrieves the application category object associated with the specified ID. If no ID is specified, retrieves list of all application category objects.**", "operationId": "getApplicationCategory", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationCategory" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationcategories/2325" }, "type": "ApplicationCategory", "name": "050plus", "id": "2325", "metadata": { "count": 1094 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/applicationfilters": { "get": { "tags": [ "Object" ], "summary": "getAllApplicationFilter", "description": "**Retrieves the application filter object associated with the specified ID. If no ID is specified, retrieves list of all application filter objects.**", "operationId": "getAllApplicationFilter", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationFilterListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationfilters?offset=0&limit=1" }, "items": [ { "name": "test1", "id": "907b5452-e4e0-11e5-87ba-df5089dc85eb", "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationfilters/907b5452-e4e0-11e5-87ba-df5089dc85eb" }, "type": "ApplicationFilter" } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/applicationfilters/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getApplicationFilter", "description": "**Retrieves the application filter object associated with the specified ID. If no ID is specified, retrieves list of all application filter objects.**", "operationId": "getApplicationFilter", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationFilter" }, "example": { "appConditions": [ { "search": "Risks:Very Low Business Relevance:Very Low", "risks": [ { "type": "ApplicationRisk", "name": "Very Low", "id": "VERY_LOW" } ], "productivities": [ { "name": "Very Low", "id": "VERY_LOW", "type": "ApplicationProductivity", "metadata": { "count": 218 } } ] } ], "name": "test1", "id": "907b5452-e4e0-11e5-87ba-df5089dc85eb", "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationfilters/907b5452-e4e0-11e5-87ba-df5089dc85eb" }, "type": "ApplicationFilter", "metadata": { "count": 218 }, "applications": [ { "appProductivity": { "name": "Very Low", "id": "VERY_LOW", "type": "ApplicationProductivity", "metadata": { "count": 0 } }, "decrypted": false, "type": "Application", "name": "21 Questions", "risk": { "type": "ApplicationRisk", "name": "Very Low", "id": "VERY_LOW" }, "applicationTypes": [ { "type": "ApplicationType", "metadata": { "count": 0 }, "name": "Webapp", "id": "WEBAPP" } ] } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/applicationproductivities": { "get": { "tags": [ "Object" ], "summary": "getAllApplicationProductivity", "description": "**Retrieves the application productivity object associated with the specified ID. If no ID is specified, retrieves list of all application productivity objects.**", "operationId": "getAllApplicationProductivity", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationProductivityListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationproductivities?offset=0&limit=5" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationproductivities/VERY_LOW" }, "type": "ApplicationProductivity", "name": "Very Low", "id": "VERY_LOW", "metadata": { "count": 1094 } }, { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationproductivities/LOW" }, "type": "ApplicationProductivity", "name": "Low", "id": "LOW", "metadata": { "count": 808 } } ], "paging": { "offset": 0, "limit": 2, "count": 5, "next": [ "/fmc_config/v1/domain/domainUUID/object/applicationproductivities?offset=2&limit=2", "/fmc_config/v1/domain/domainUUID/object/applicationproductivities?offset=4&limit=1" ], "pages": 3 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/applicationproductivities/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getApplicationProductivity", "description": "**Retrieves the application productivity object associated with the specified ID. If no ID is specified, retrieves list of all application productivity objects.**", "operationId": "getApplicationProductivity", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationProductivity" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationproductivities/VERY_LOW" }, "type": "ApplicationProductivity", "name": "Very Low", "id": "VERY_LOW", "metadata": { "count": 1094 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/applicationrisks": { "get": { "tags": [ "Object" ], "summary": "getAllApplicationRisk", "description": "**Retrieves the application risk object associated with the specified ID. If no ID is specified, retrieves list of all application risk objects.**", "operationId": "getAllApplicationRisk", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationRiskListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationrisks?offset=0&limit=2" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationrisks/LOW" }, "type": "ApplicationRisk", "id": "LOW", "name": "Low" }, { "links": { "self": "/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/applicationrisks/MEDIUM" }, "type": "ApplicationRisk", "id": "MEDIUM", "name": "Medium" } ], "paging": { "offset": 0, "limit": 2, "count": 5, "next": [ "/fmc_config/v1/domain/domainUUID/object/applicationrisks?offset=2&limit=2", "/fmc_config/v1/domain/domainUUID/object/applicationrisks?offset=4&limit=1" ], "pages": 3 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/applicationrisks/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getApplicationRisk", "description": "**Retrieves the application risk object associated with the specified ID. If no ID is specified, retrieves list of all application risk objects.**", "operationId": "getApplicationRisk", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationRisk" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationrisks/VERY_LOW" }, "type": "ApplicationRisk", "name": "Very Low", "id": "VERY_LOW", "metadata": { "count": 1094 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/applications": { "get": { "tags": [ "Object" ], "summary": "getAllApplication", "description": "**Retrieves the application object associated with the specified ID. If no ID is specified, retrieves list of all application objects.**", "operationId": "getAllApplication", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applications?offset=0&limit=5" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applications/1234" }, "type": "Application", "name": "Very Low 1234", "id": "1234", "metadata": { "count": 1094 } }, { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applications/2325" }, "type": "Application", "name": "050plus", "id": "2325", "metadata": { "count": 808 } } ], "paging": { "offset": 0, "limit": 2, "count": 5, "next": [ "/fmc_config/v1/domain/domainUUID/object/applications?offset=2&limit=2", "/fmc_config/v1/domain/domainUUID/object/applications?offset=4&limit=1" ], "pages": 3 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/applications/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getApplication", "description": "**Retrieves the application object associated with the specified ID. If no ID is specified, retrieves list of all application objects.**", "operationId": "getApplication", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applications/2325" }, "type": "Application", "name": "050plus", "id": "2325", "metadata": { "count": 1094 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/applicationtags": { "get": { "tags": [ "Object" ], "summary": "getAllApplicationTag", "description": "**Retrieves the application tag object associated with the specified ID. If no ID is specified, retrieves list of all application tag objects.**", "operationId": "getAllApplicationTag", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationTagListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationtags?offset=0&limit=2" }, "items": [ { "type": "ApplicationTag", "id": "2325", "name": "Low", "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationtags/2325" } }, { "type": "ApplicationTag", "id": "1234", "name": "Medium", "links": { "self": "/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/applicationtags/1234" } } ], "paging": { "offset": 0, "limit": 2, "count": 5, "next": [ "/fmc_config/v1/domain/domainUUID/object/applicationtags?offset=2&limit=2", "/fmc_config/v1/domain/domainUUID/object/applicationtags?offset=4&limit=1" ], "pages": 3 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/applicationtags/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getApplicationTag", "description": "**Retrieves the application tag object associated with the specified ID. If no ID is specified, retrieves list of all application tag objects.**", "operationId": "getApplicationTag", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationTag" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationtags/2325" }, "type": "ApplicationTag", "name": "tag1", "id": "2325", "metadata": { "count": 1094 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/applicationtypes": { "get": { "tags": [ "Object" ], "summary": "getAllApplicationType", "description": "**Retrieves the application type object associated with the specified ID. If no ID is specified, retrieves list of all application type objects.**", "operationId": "getAllApplicationType", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationTypeListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationtypes?offset=0&limit=5" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationtypes/1234" }, "type": "ApplicationType", "name": "Very Low 1234", "id": "1234", "metadata": { "count": 1094 } }, { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationtypes/2325" }, "type": "ApplicationType", "name": "050plus", "id": "2325", "metadata": { "count": 808 } } ], "paging": { "offset": 0, "limit": 2, "count": 5, "next": [ "/fmc_config/v1/domain/domainUUID/object/applicationtypes?offset=2&limit=2", "/fmc_config/v1/domain/domainUUID/object/applicationtypes?offset=4&limit=1" ], "pages": 3 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/applicationtypes/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getApplicationType", "description": "**Retrieves the application type object associated with the specified ID. If no ID is specified, retrieves list of all application type objects.**", "operationId": "getApplicationType", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationType" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/applicationtypes/2325" }, "type": "ApplicationType", "name": "type1", "id": "2325", "metadata": { "count": 1094 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/certenrollments": { "get": { "tags": [ "Object" ], "summary": "getAllVpnPKIEnrollmentModel", "description": "**Retrieves the Cert Enrollment object associated with the specified ID. If no ID is specified for a GET, retrieves list of all PKI enrollment objects.**", "operationId": "getAllVpnPKIEnrollmentModel", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnPKIEnrollmentModelListContainer" }, "example": { "links": { "self": "https://bglgrp0231-pod.cisco.com:13655/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments?offset=0&limit=1" }, "items": [ { "links": { "self": "https://bglgrp0231-pod.cisco.com:13655/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/005056A9-039E-0ed3-0000-476741369876" }, "type": "CertEnrollment", "name": "PKI_Single", "id": "005056A9-039E-0ed3-0000-476741369876" } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getVpnPKIEnrollmentModel", "description": "**Retrieves the Cert Enrollment object associated with the specified ID. If no ID is specified for a GET, retrieves list of all PKI enrollment objects.**", "operationId": "getVpnPKIEnrollmentModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for Cert Enrollment object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VpnPKIEnrollmentModel" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/continents": { "get": { "tags": [ "Object" ], "summary": "getAllContinentObject", "description": "**Retrieves the continent object associated with the specified ID. If no ID is specified, retrieves list of all continent objects.**", "operationId": "getAllContinentObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContinentObjectListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/continents?offset=0&limit=1" }, "items": [ { "id": "6", "name": "North America", "type": "Continent", "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/continents/6" }, "countries": [ { "id": "533", "name": "Aruba", "iso2": "aw", "iso3": "abw", "type": "Country" }, { "id": "660", "name": "Anguilla", "iso2": "ai", "iso3": "aia", "type": "Country" }, { "id": "530", "name": "Netherlands Antilles", "iso2": "an", "iso3": "ant", "type": "Country" }, { "id": "28", "name": "Antigua and Barbuda", "iso2": "ag", "iso3": "atg", "type": "Country" }, { "id": "535", "name": "Bonaire, Sint Eustatius and Saba", "iso2": "bq", "iso3": "bes", "type": "Country" }, { "id": "44", "name": "Bahamas", "iso2": "bs", "iso3": "bhs", "type": "Country" }, { "id": "652", "name": "Saint Barthélemy", "iso2": "bl", "iso3": "blm", "type": "Country" }, { "id": "84", "name": "Belize", "iso2": "bz", "iso3": "blz", "type": "Country" }, { "id": "60", "name": "Bermuda", "iso2": "bm", "iso3": "bmu", "type": "Country" }, { "id": "52", "name": "Barbados", "iso2": "bb", "iso3": "brb", "type": "Country" }, { "id": "124", "name": "Canada", "iso2": "ca", "iso3": "can", "type": "Country" }, { "id": "188", "name": "Costa Rica", "iso2": "cr", "iso3": "cri", "type": "Country" }, { "id": "192", "name": "Cuba", "iso2": "cu", "iso3": "cub", "type": "Country" }, { "id": "531", "name": "Curaçao", "iso2": "cw", "iso3": "cuw", "type": "Country" }, { "id": "136", "name": "Cayman Islands", "iso2": "ky", "iso3": "cym", "type": "Country" }, { "id": "212", "name": "Dominica", "iso2": "dm", "iso3": "dma", "type": "Country" }, { "id": "214", "name": "Dominican Republic", "iso2": "do", "iso3": "dom", "type": "Country" }, { "id": "312", "name": "Guadeloupe", "iso2": "gp", "iso3": "glp", "type": "Country" }, { "id": "308", "name": "Grenada", "iso2": "gd", "iso3": "grd", "type": "Country" }, { "id": "304", "name": "Greenland", "iso2": "gl", "iso3": "grl", "type": "Country" }, { "id": "320", "name": "Guatemala", "iso2": "gt", "iso3": "gtm", "type": "Country" }, { "id": "340", "name": "Honduras", "iso2": "hn", "iso3": "hnd", "type": "Country" }, { "id": "332", "name": "Haiti", "iso2": "ht", "iso3": "hti", "type": "Country" }, { "id": "388", "name": "Jamaica", "iso2": "jm", "iso3": "jam", "type": "Country" }, { "id": "659", "name": "Saint Kitts And Nevis", "iso2": "kn", "iso3": "kna", "type": "Country" }, { "id": "662", "name": "Saint Lucia", "iso2": "lc", "iso3": "lca", "type": "Country" }, { "id": "663", "name": "Saint Martin", "iso2": "mf", "iso3": "maf", "type": "Country" }, { "id": "484", "name": "Mexico", "iso2": "mx", "iso3": "mex", "type": "Country" }, { "id": "500", "name": "Montserrat", "iso2": "ms", "iso3": "msr", "type": "Country" }, { "id": "474", "name": "Martinique", "iso2": "mq", "iso3": "mtq", "type": "Country" }, { "id": "558", "name": "Nicaragua", "iso2": "ni", "iso3": "nic", "type": "Country" }, { "id": "591", "name": "Panama", "iso2": "pa", "iso3": "pan", "type": "Country" }, { "id": "630", "name": "Puerto Rico", "iso2": "pr", "iso3": "pri", "type": "Country" }, { "id": "222", "name": "El Salvador", "iso2": "sv", "iso3": "slv", "type": "Country" }, { "id": "666", "name": "Saint Pierre And Miquelon", "iso2": "pm", "iso3": "spm", "type": "Country" }, { "id": "534", "name": "Sint Maarten (Dutch part)", "iso2": "sx", "iso3": "sxm", "type": "Country" }, { "id": "796", "name": "Turks And Caicos Islands", "iso2": "tc", "iso3": "tca", "type": "Country" }, { "id": "780", "name": "Trinidad and Tobago", "iso2": "tt", "iso3": "tto", "type": "Country" }, { "id": "840", "name": "United States", "iso2": "us", "iso3": "usa", "type": "Country" }, { "id": "670", "name": "Saint Vincent And The Grenadines", "iso2": "vc", "iso3": "vct", "type": "Country" }, { "id": "92", "name": "British Virgin Islands", "iso2": "vg", "iso3": "vgb", "type": "Country" }, { "id": "850", "name": "U.S. Virgin Islands", "iso2": "vi", "iso3": "vir", "type": "Country" } ] } ], "paging": { "offset": 0, "limit": 1, "count": 7, "pages": 7, "next": [ "/fmc_config/v1/domain/DomainUUID/object/continents?offset=1&limit=1", "/fmc_config/v1/domain/DomainUUID/object/continents?offset=2&limit=1", "/fmc_config/v1/domain/DomainUUID/object/continents?offset=3&limit=1", "/fmc_config/v1/domain/DomainUUID/object/continents?offset=4&limit=1" ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/continents/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getContinentObject", "description": "**Retrieves the continent object associated with the specified ID. If no ID is specified, retrieves list of all continent objects.**", "operationId": "getContinentObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of continent objects.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContinentObject" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/continents/2" }, "id": "2", "name": "Antarctica", "type": "Continent", "countries": [ { "id": "10", "name": "Antarctica", "iso2": "aq", "iso3": "ata", "type": "Country" }, { "id": "260", "name": "French Southern Territories", "iso2": "tf", "iso3": "atf", "type": "Country" }, { "id": "74", "name": "Bouvet Island", "iso2": "bv", "iso3": "bvt", "type": "Country" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/countries": { "get": { "tags": [ "Object" ], "summary": "getAllCountryObject", "description": "**Retrieves the country object associated with the specified ID. If no ID is specified, retrieves list of all country objects.**", "operationId": "getAllCountryObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountryObjectListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/countries?offset=0&limit=2" }, "items": [ { "id": "countryUUID", "name": "Aruba", "iso2": "aw", "iso3": "abw", "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/countries/countryUUID" }, "type": "Country" }, { "id": "country2UUID", "name": "Anguilla", "iso2": "ai", "iso3": "aia", "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/countries/country2UUID" }, "type": "Country" } ], "paging": { "offset": 0, "limit": 2, "count": 252, "next": [ "/fmc_config/v1/domain/DomainUUID/object/countries?offset=2&limit=2", "/fmc_config/v1/domain/DomainUUID/object/countries?offset=4&limit=2", "/fmc_config/v1/domain/DomainUUID/object/countries?offset=6&limit=2", "/fmc_config/v1/domain/DomainUUID/object/countries?offset=8&limit=2" ], "pages": 126 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/countries/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getCountryObject", "description": "**Retrieves the country object associated with the specified ID. If no ID is specified, retrieves list of all country objects.**", "operationId": "getCountryObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of continent objects.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountryObject" }, "example": { "id": "countryUUID", "name": "Aruba", "iso2": "aw", "iso3": "abw", "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/countries/countryUUID" }, "type": "Country" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/dnsservergroups": { "get": { "tags": [ "Object" ], "summary": "getAllDNSServerGroupObject", "description": "**Retrieves, deletes, creates, or modifies the DNS Server Group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all DNS Server Group objects.**", "operationId": "getAllDNSServerGroupObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServerGroupObjectListContainer" }, "example": { "links": { "self": "api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups?offset=0&limit=3" }, "items": [ { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID" }, "type": "DNSServerGroupObject", "name": "DNSServerGroupObjectName1", "id": "DNSServerGroupObjectUUID" }, { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID" }, "type": "DNSServerGroupObject", "name": "DNSServerGroupObjectName2", "id": "DNSServerGroupObjectUUID" }, { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID" }, "type": "DNSServerGroupObject", "name": "DNSServerGroupObjectName3", "id": "DNSServerGroupObjectUUID" } ], "paging": { "offset": 0, "limit": 3, "count": 3, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createDNSServerGroupObject", "description": "**Retrieves, deletes, creates, or modifies the DNS Server Group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all DNS Server Group objects. _Check the response section for applicable examples (if any)._**", "operationId": "createDNSServerGroupObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of DNS Server Group object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServerGroupObject" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServerGroupObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/dnsservergroups/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getDNSServerGroupObject", "description": "**Retrieves, deletes, creates, or modifies the DNS Server Group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all DNS Server Group objects.**", "operationId": "getDNSServerGroupObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for DNS Server Group object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServerGroupObject" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID" }, "dnsservers": [ { "name-server": "IPv4/IPv6hostaddress1" }, { "name-server": "IPv4/IPv6hostaddress2" } ], "retries": 1, "defaultdomain": "cisco.com", "type": "DNSServerGroupObject", "name": "DNSServerGroupObjectName1", "timeout": 1, "id": "DNSServerGroupObjectUUID", "metadata": { "timestamp": 1523597066886, "lastUser": { "name": "rest" }, "domain": { "name": "Global", "id": "DomainUUID" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateDNSServerGroupObject", "description": "**Retrieves, deletes, creates, or modifies the DNS Server Group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all DNS Server Group objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateDNSServerGroupObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for DNS Server Group object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of DNS Server Group object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServerGroupObject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServerGroupObject" }, "example": { "dnsservers": [ { "name-server": "IPv4/IPv6hostaddress1" }, { "name-server": "IPv4/IPv6hostaddress2" } ], "retries": 1, "defaultdomain": "cisco.com", "type": "DNSServerGroupObject", "name": "DNSServerGroupObjectName1", "timeout": 1, "id": "DNSServerGroupObjectUUID" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteDNSServerGroupObject", "description": "**Retrieves, deletes, creates, or modifies the DNS Server Group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all DNS Server Group objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteDNSServerGroupObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for DNS Server Group object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServerGroupObject" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID" }, "dnsservers": [ { "name-server": "IPv4/IPv6hostaddress1" }, { "name-server": "IPv4/IPv6hostaddress2" } ], "retries": 1, "defaultdomain": "cisco.com", "type": "DNSServerGroupObject", "name": "DNSServerGroupObjectName1", "timeout": 1, "id": "DNSServerGroupObjectUUID", "metadata": { "timestamp": 1524129145233, "lastUser": { "name": "rest" }, "domain": { "name": "Global", "id": "DomainUUID" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/endpointdevicetypes": { "get": { "tags": [ "Object" ], "summary": "getAllEndPointDeviceType", "description": "**Retrieves the endpoint device type object associated with the specified ID. If no ID is specified, retrieves list of all endpoint device type objects.**", "operationId": "getAllEndPointDeviceType", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndPointDeviceTypeListContainer" }, "example": { "links": { "self": "httpshttps://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/endpointdevicetypes?expanded=true" }, "items": [ { "name": "ExampleEndPointDeviceTypename", "id": "exampleEndPointDeviceTypeuuid", "type": "EndPointDeviceType", "description": "example description.", "fqName": "", "links": { "self": "https://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/endpointdevicetypes/exampleEndPointDeviceTypeuuid" }, "metadata": { "readOnly": { "state": true }, "timestamp": 41540695097, "lastUser": { "name": "testuser", "id": "testuseruuid", "type": "User" }, "domain": { "name": "TestDomain", "id": "testdomainuuid", "type": "Domain" } } }, { "name": "ExampleEndPointDeviceTypename2", "id": "exampleEndPointDeviceTypeuuid2", "type": "EndPointDeviceType", "description": "example description.2", "fqName": "", "links": { "self": "https://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/endpointdevicetypes/exampleEndPointDeviceTypeuuid2" }, "metadata": { "readOnly": { "state": true }, "timestamp": 414393589, "lastUser": { "name": "testuser2", "id": "testuseruuid2", "type": "User" }, "domain": { "name": "TestDomain2", "id": "testdomainuuid2", "type": "Domain" } } } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/endpointdevicetypes/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getEndPointDeviceType", "description": "**Retrieves the endpoint device type object associated with the specified ID. If no ID is specified, retrieves list of all endpoint device type objects.**", "operationId": "getEndPointDeviceType", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the endpoint device type object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndPointDeviceType" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslist": { "get": { "tags": [ "Object" ], "summary": "getAllExtendedAccessListModel", "description": "**Retrieves list of all Extended Access List objects.**", "operationId": "getAllExtendedAccessListModel", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendedAccessListModelListContainer" }, "example": { "links": { "self": "https://bglgrp0231-pod.cisco.com:13655/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/extendedaccesslist?offset=0&limit=1" }, "items": [ { "links": { "self": "https://bglgrp0231-pod.cisco.com:13655/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/extendedaccesslist/005056A9-039E-0ed3-0000-476741369876" }, "type": "extendedaccesslist", "name": "ACL1", "id": "005056A9-039E-0ed3-0000-476741369876" } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslist/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getExtendedAccessListModel", "description": "**Retrieves list of all Extended Access List objects.**", "operationId": "getExtendedAccessListModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique Identifier of a Extended Access List object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendedAccessListModel" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/fqdns": { "get": { "tags": [ "Object" ], "summary": "getAllFQDNObject", "description": "**Retrieves, deletes, creates, or modifies the FQDN object associated with the specified ID. If no ID is specified for a GET, retrieves list of all FQDN objects.**", "operationId": "getAllFQDNObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FQDNObjectListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createFQDNObject", "description": "**Retrieves, deletes, creates, or modifies the FQDN object associated with the specified ID. If no ID is specified for a GET, retrieves list of all FQDN objects. _Check the response section for applicable examples (if any)._**", "operationId": "createFQDNObject", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for FQDN objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of FQDN object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FQDNObject" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FQDNObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/fqdns/{containerUUID}/overrides": { "get": { "tags": [ "Object" ], "summary": "getAllFQDNOverride", "description": "**Retrieves all(Domain and Device) overrides on a FQDN object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getAllFQDNOverride", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FQDNOverrideListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/fqdns/fqdnObjectUUID/overrides?offset=0&limit=1" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/fqdns/fqdnObjectUUID?overrideTargetId=targetUUID" }, "type": "FQDN", "value": "a.b.c.d.com", "dnsResolution": "IPV4_AND_IPV6", "overrides": { "parent": { "id": "fqdnObjectUUID", "type": "FQDN" }, "target": { "name": "10.10.19.27", "id": "targetUUID", "type": "Device" } }, "overridable": true, "description": " ", "name": "fqdn_obj", "id": "fqdnObjectUUID", "metadata": { "timestamp": 1520428174236, "lastUser": { "name": "user1" }, "domain": { "name": "Global \\ INDIA \\ BENGALURU", "id": "domainUUID" } } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/fqdns/{containerUUID}/overrides/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getFQDNOverride", "description": "**Retrieves all(Domain and Device) overrides on a FQDN object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getFQDNOverride", "parameters": [ { "name": "objectId", "in": "path", "description": "Input NOT Expected here", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FQDNOverride" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/fqdns/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getFQDNObject", "description": "**Retrieves, deletes, creates, or modifies the FQDN object associated with the specified ID. If no ID is specified for a GET, retrieves list of all FQDN objects.**", "operationId": "getFQDNObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for FQDN object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "overrideTargetId", "in": "query", "description": "Retrieves the override(s) associated with the FQDN object on given target ID.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FQDNObject" }, "example": { "links": { "self": "/fmc_config/v1/domain/default/object/fqdns/5555-6666-7777-8888", "parent": "/fmc_config/v1/domain/default/object/networkaddresses" }, "type": "FQDN", "value": "www.cisco.com", "dnsResolution": "IPV4_ONLY", "overridable": false, "description": "Test Description", "id": "5555-6666-7777-8888", "name": "TestFQDN", "metadata": { "lastUser": { "name": "admin" }, "domain": { "name": "Global", "id": "domainUuid" }, "parentType": "NetworkAddress" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateFQDNObject", "description": "**Retrieves, deletes, creates, or modifies the FQDN object associated with the specified ID. If no ID is specified for a GET, retrieves list of all FQDN objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateFQDNObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for FQDN object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of FQDN object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FQDNObject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FQDNObject" }, "example": { "type": "FQDN", "value": "www.cisco.com", "dnsResolution": "IPV6_ONLY", "overridable": false, "description": "Test Description", "id": "5555-6666-7777-8888", "name": "TestFQDN" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteFQDNObject", "description": "**Retrieves, deletes, creates, or modifies the FQDN object associated with the specified ID. If no ID is specified for a GET, retrieves list of all FQDN objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteFQDNObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for FQDN object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FQDNObject" }, "example": { "links": { "self": "/fmc_config/v1/domain/default/object/fqdns/5555-6666-7777-8888", "parent": "/fmc_config/v1/domain/default/object/networkaddresses" }, "type": "FQDN", "value": "www.cisco.com", "dnsResolution": "IPV6_ONLY", "overridable": false, "description": "Test Description", "id": "5555-6666-7777-8888", "name": "TestFQDN", "metadata": { "lastUser": { "name": "admin" }, "domain": { "name": "Global", "id": "domainUuid" }, "parentType": "NetworkAddress" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/geolocations": { "get": { "tags": [ "Object" ], "summary": "getAllGeoLocationObject", "description": "**Retrieves the geolocation object associated with the specified ID. If no ID is specified, retrieves list of all geolocation objects.**", "operationId": "getAllGeoLocationObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoLocationObjectListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/geolocations?offset=0&limit=1" }, "items": [ { "name": "geolocation_1", "type": "Geolocation", "id": "geolocationUUID", "links": { "self": "fmc_config/v1/domain/DomainUUID/object/geolocations/geolocationUUID" } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/geolocations/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getGeoLocationObject", "description": "**Retrieves the geolocation object associated with the specified ID. If no ID is specified, retrieves list of all geolocation objects.**", "operationId": "getGeoLocationObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of geolocation objects.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoLocationObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/hosts": { "get": { "tags": [ "Object" ], "summary": "getAllHostObject", "description": "**Retrieves, deletes, creates, or modifies the host object associated with the specified ID. If no ID is specified for a GET, retrieves list of all host objects.**", "operationId": "getAllHostObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostObjectListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/GloablDomainUUID/object/hosts?offset=0&limit=1" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/GloablDomainUUID/object/hosts/hostObject2UUID", "parent": "/fmc_config/v1/domain/GloablDomainUUID/object/networkaddresses" }, "type": "Host", "value": "1.2.3.4", "overrides": { "parent": { "id": "hostObject2UUID", "type": "Host" }, "target": { "name": "Global \\ Asia", "id": "domainUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "pvs_global", "id": "hostObject2UUID", "metadata": { "lastUser": { "name": "pvs" }, "domain": { "name": "Global \\ Asia", "id": "domainUUID" }, "ipType": "V_4", "parentType": "NetworkAddress" } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createHostObject", "description": "**Retrieves, deletes, creates, or modifies the host object associated with the specified ID. If no ID is specified for a GET, retrieves list of all host objects. _Check the response section for applicable examples (if any)._**", "operationId": "createHostObject", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for host objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of host object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostObject" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/hosts/{containerUUID}/overrides": { "get": { "tags": [ "Object" ], "summary": "getAllHostOverride", "description": "**Retrieves all(Domain and Device) overrides on a Host object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getAllHostOverride", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostOverrideListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/hosts/hostUUID/overrides?offset=0&limit=2" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/hosts/hostUUID?overrideTargetId=targetUUID" }, "type": "Host", "value": "3.3.3.3", "overrides": { "parent": { "id": "hostUUID", "type": "Host" }, "target": { "name": "Global \\ BENGALURU", "id": "domainUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "Host_1", "id": "hostUUID", "metadata": { "timestamp": 1520333477540, "lastUser": { "name": "user1" }, "domain": { "name": "Global \\ BENGALURU", "id": "domainUUID" } } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/hosts/{containerUUID}/overrides/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getHostOverride", "description": "**Retrieves all(Domain and Device) overrides on a Host object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getHostOverride", "parameters": [ { "name": "objectId", "in": "path", "description": "Input NOT Expected here", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostOverride" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/hosts/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getHostObject", "description": "**Retrieves, deletes, creates, or modifies the host object associated with the specified ID. If no ID is specified for a GET, retrieves list of all host objects.**", "operationId": "getHostObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for host object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "overrideTargetId", "in": "query", "description": "Retrieves the override(s) associated with the host object on given target ID.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostObject" }, "example": { "links": { "self": "/fmc_config/v1/domain/default/object/hosts/hostObject3UUID", "parent": "/fmc_config/v1/domain/default/object/networkaddresses" }, "type": "Host", "value": "10.5.3.28", "overridable": false, "description": "Test Description", "id": "hostObject3UUID", "name": "TestHost", "metadata": { "lastUser": { "name": "admin" }, "domain": { "name": "Global", "id": "GloablDomainUUID" }, "ipType": "V_4", "parentType": "NetworkAddress" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateHostObject", "description": "**Retrieves, deletes, creates, or modifies the host object associated with the specified ID. If no ID is specified for a GET, retrieves list of all host objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateHostObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for host object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of host object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostObject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostObject" }, "example": { "type": "Host", "value": "10.5.3.28", "overridable": false, "description": "Test Description", "id": "hostObject3UUID", "name": "TestHost" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteHostObject", "description": "**Retrieves, deletes, creates, or modifies the host object associated with the specified ID. If no ID is specified for a GET, retrieves list of all host objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteHostObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for host object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostObject" }, "example": { "links": { "self": "/fmc_config/v1/domain/default/object/hosts/hostObject3UUID", "parent": "/fmc_config/v1/domain/default/object/networkaddresses" }, "type": "Host", "value": "10.5.3.28", "overridable": false, "description": "Test Description", "id": "hostObject3UUID", "name": "TestHost", "metadata": { "lastUser": { "name": "admin" }, "domain": { "name": "Global", "id": "GloablDomainUUID" }, "ipType": "V_4", "parentType": "NetworkAddress" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/icmpv4objects": { "get": { "tags": [ "Object" ], "summary": "getAllICMPV4Object", "description": "**Retrieves, deletes, creates, or modifies the icmpv4 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all icmpv4 objects.**", "operationId": "getAllICMPV4Object", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV4ObjectListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/global/object/icmpv4objects?offset=0&limit=1" }, "items": [ { "metadata": { "lastUser": { "name": "pvs" }, "domain": { "name": "Global \\ Asia", "id": "childDomainUUID" }, "parentType": "Port" }, "links": { "self": "/fmc_config/v1/domain/global/object/icmpv4objects/icmpv4ObjectUUID", "parent": "/fmc_config/v1/domain/global/object/ports" }, "type": "ICMPV4Object", "code": 0, "icmpType": "3", "overrides": { "parent": { "id": "icmpv4ObjectUUID", "type": "ICMPV4Object" }, "target": { "name": "Global \\ Asia", "id": "childDomainUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "pvs_icmpv4", "id": "icmpv4ObjectUUID" } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createICMPV4Object", "description": "**Retrieves, deletes, creates, or modifies the icmpv4 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all icmpv4 objects. _Check the response section for applicable examples (if any)._**", "operationId": "createICMPV4Object", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for ICMPv4 objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input icmpv4 object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV4Object" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV4Object" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/icmpv4objects/{containerUUID}/overrides": { "get": { "tags": [ "Object" ], "summary": "getAllICMPV4ObjectOverride", "description": "**Retrieves all(Domain and Device) overrides on a ICMPV4 object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getAllICMPV4ObjectOverride", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV4ObjectOverrideListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/icmpv4objects/icmpv4ObjectUUID/overrides?offset=0&limit=1" }, "items": [ { "metadata": { "timestamp": 1520343093440, "lastUser": { "name": "user" }, "domain": { "name": "Global \\ INDIA", "id": "domainUUID" }, "parentType": "PortObject" }, "links": { "self": "/fmc_config/v1/domain/domainUUID/object/icmpv4objects/icmpv4ObjectUUID?overrideTargetId=targetUUID" }, "type": "ICMPV4Object", "icmpType": "3", "overrides": { "parent": { "id": "icmpv4ObjectUUID", "type": "ICMPV4Object" }, "target": { "name": "10.10.19.25", "id": "targetUUID", "type": "Device" } }, "overridable": true, "description": " ", "name": "port_1", "id": "icmpv4ObjectUUID" } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/icmpv4objects/{containerUUID}/overrides/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getICMPV4ObjectOverride", "description": "**Retrieves all(Domain and Device) overrides on a ICMPV4 object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getICMPV4ObjectOverride", "parameters": [ { "name": "objectId", "in": "path", "description": "Input NOT Expected here", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV4ObjectOverride" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/icmpv4objects/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getICMPV4Object", "description": "**Retrieves, deletes, creates, or modifies the icmpv4 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all icmpv4 objects.**", "operationId": "getICMPV4Object", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "overrideTargetId", "in": "query", "description": "Retrieves the override(s) associated with the ICMPv4 object on given target ID.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV4Object" }, "example": { "id": "icmpv4Object1UUID", "name": "icmpv4_obj1", "type": "ICMPV4Object", "icmpType": "3", "code": 0 } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateICMPV4Object", "description": "**Retrieves, deletes, creates, or modifies the icmpv4 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all icmpv4 objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateICMPV4Object", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input icmpv4 object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV4Object" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV4Object" }, "example": { "id": "icmpv4Object1UUID", "name": "icmpv4_obj1_updated", "type": "ICMPV4Object", "icmpType": "3", "code": 1 } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteICMPV4Object", "description": "**Retrieves, deletes, creates, or modifies the icmpv4 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all icmpv4 objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteICMPV4Object", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV4Object" }, "example": { "id": "icmpv4Object2UUID", "name": "icmpv4_obj2", "type": "ICMPV4Object", "icmpType": "3", "code": 0 } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/icmpv6objects": { "get": { "tags": [ "Object" ], "summary": "getAllICMPV6Object", "description": "**Retrieves, deletes, creates, or modifies the icmpv6 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all icmpv6 objects.**", "operationId": "getAllICMPV6Object", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV6ObjectListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/childDomainUUID/object/icmpv6objects?offset=0&limit=1" }, "items": [ { "metadata": { "lastUser": { "name": "pvs" }, "domain": { "name": "Global \\ Asia", "id": "childDomainUUID" }, "parentType": "Port" }, "links": { "self": "/fmc_config/v1/domain/childDomainUUID/object/icmpv6objects/icmpv6ObjectUUID", "parent": "/fmc_config/v1/domain/childDomainUUID/object/ports" }, "type": "ICMPV6Object", "code": 0, "icmpType": "3", "overrides": { "parent": { "id": "icmpv6ObjectUUID", "type": "ICMPV6Object" }, "target": { "name": "Global \\ Asia", "id": "childDomainUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "pvs_icmpv6", "id": "icmpv6ObjectUUID" } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createICMPV6Object", "description": "**Retrieves, deletes, creates, or modifies the icmpv6 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all icmpv6 objects. _Check the response section for applicable examples (if any)._**", "operationId": "createICMPV6Object", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for ICMPv6 objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input icmpv6 object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV6Object" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV6Object" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/icmpv6objects/{containerUUID}/overrides": { "get": { "tags": [ "Object" ], "summary": "getAllICMPV6ObjectOverride", "description": "**[DEV ERROR: Missing description]**", "operationId": "getAllICMPV6ObjectOverride", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV6ObjectOverrideListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/icmpv6objects/icmpv6ObjectUUID/overrides?offset=0&limit=1" }, "items": [ { "metadata": { "timestamp": 1520343130476, "lastUser": { "name": "user" }, "domain": { "name": "Global \\ BENGALURU", "id": "domainUUID" }, "parentType": "PortObject" }, "links": { "self": "/fmc_config/v1/domain/domainUUID/object/icmpv6objects/icmpv6ObjectUUID?overrideTargetId=targetUUID" }, "type": "ICMPV6Object", "icmpType": "131", "overrides": { "parent": { "id": "icmpv6ObjectUUID", "type": "ICMPV6Object" }, "target": { "name": "Global \\ BENGALURU", "id": "targetUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "icmp_6", "id": "icmpv6ObjectUUID" } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/icmpv6objects/{containerUUID}/overrides/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getICMPV6ObjectOverride", "description": "**[DEV ERROR: Missing description]**", "operationId": "getICMPV6ObjectOverride", "parameters": [ { "name": "objectId", "in": "path", "description": "[DEV ERROR: Missing description]", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV6ObjectOverride" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/icmpv6objects/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getICMPV6Object", "description": "**Retrieves, deletes, creates, or modifies the icmpv6 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all icmpv6 objects.**", "operationId": "getICMPV6Object", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "overrideTargetId", "in": "query", "description": "Retrieves the override(s) associated with the ICMPv6 object on given target ID.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV6Object" }, "example": { "id": "icmpv6ObjectUUID", "name": "icmpv6_obj1", "type": "ICMPV6Object", "icmpType": "3", "code": 0 } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateICMPV6Object", "description": "**Retrieves, deletes, creates, or modifies the icmpv6 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all icmpv6 objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateICMPV6Object", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input icmpv6 object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV6Object" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV6Object" }, "example": { "id": "icmpv6ObjectUUID", "name": "icmpv6_obj1_updated", "type": "ICMPV6Object", "icmpType": "3", "code": 1 } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteICMPV6Object", "description": "**Retrieves, deletes, creates, or modifies the icmpv6 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all icmpv6 objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteICMPV6Object", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICMPV6Object" }, "example": { "id": "icmpv6Object2UUID", "name": "icmpv6_obj2", "type": "ICMPV6Object", "icmpType": "3", "code": 0 } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/ikev1ipsecproposals": { "get": { "tags": [ "Object" ], "summary": "getAllIKEv1IPsecProposal", "description": "**Retrieves, deletes, creates, or modifies the IKEv1 IPSec Proposal associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv1 IPSec Proposal objects.**", "operationId": "getAllIKEv1IPsecProposal", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEv1IPsecProposalListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals?offset=0&limit=2" }, "items": [ { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID" }, "name": "ikev1ipsecproposal-1", "description": "IKEv1 IPsec object description", "id": "ikev1ipsecproposalUUID", "espEncryption": "AES-192", "espHash": "SHA", "type": "IKEv1IPsecProposal" }, { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID" }, "name": "ikev1ipsecproposal-2", "description": "IKEv1 IPsec object description", "id": "ikev1ipsecproposalUUID", "espEncryption": "DES", "espHash": "MD5", "type": "IKEv1IPsecProposal" } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createIKEv1IPsecProposal", "description": "**Retrieves, deletes, creates, or modifies the IKEv1 IPSec Proposal associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv1 IPSec Proposal objects. _Check the response section for applicable examples (if any)._**", "operationId": "createIKEv1IPsecProposal", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of IKEv1 IPSec Proposal object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEv1IPsecProposal" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEv1IPsecProposal" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/ikev1ipsecproposals/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getIKEv1IPsecProposal", "description": "**Retrieves, deletes, creates, or modifies the IKEv1 IPSec Proposal associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv1 IPSec Proposal objects.**", "operationId": "getIKEv1IPsecProposal", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for IKEv1 IPSec Proposal object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEv1IPsecProposal" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID" }, "espEncryption": "AES-192", "espHash": "NONE", "name": "ikev1ipsecproposal-1", "description": "IKEv1 IPsec Proposal object description", "id": "ikev1ipsecproposalUUID", "type": "IKEv1IPsecProposal" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateIKEv1IPsecProposal", "description": "**Retrieves, deletes, creates, or modifies the IKEv1 IPSec Proposal associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv1 IPSec Proposal objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateIKEv1IPsecProposal", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for IKEv1 IPSec Proposal object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of IKEv1 IPSec Proposal object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEv1IPsecProposal" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEv1IPsecProposal" }, "example": { "name": "ikev1ipsecproposal-test-1", "id": "ikev1ipsecproposalUUID", "espEncryption": "DES", "espHash": "NONE", "description": "IKEv1 IPsec object description" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteIKEv1IPsecProposal", "description": "**Retrieves, deletes, creates, or modifies the IKEv1 IPSec Proposal associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv1 IPSec Proposal objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteIKEv1IPsecProposal", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for IKEv1 IPSec Proposal object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEv1IPsecProposal" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID", "parent": "/api/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals" }, "name": "ikev1ipsecproposal-test-1", "id": "ikev1ipsecproposalUUID", "espEncryption": "DES", "espHash": "MD5", "type": "IKEv1IPsecProposal", "description": "IKEv1 IPsec object description" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/ikev1policies": { "get": { "tags": [ "Object" ], "summary": "getAllIkev1PolicyObject", "description": "**Retrieves, deletes, creates, or modifies the IKEv1 policy object associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv1 policy objects.**", "operationId": "getAllIkev1PolicyObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ikev1PolicyObjectListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/ikev1policies?offset=0&limit=2" }, "items": [ { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID" }, "priority": 20, "lifetimeInSeconds": 86400, "diffieHellmanGroup": 5, "authenticationMethod": "Preshared Key", "encryption": "AES-128", "hash": "SHA", "name": "ikev1policy-1", "description": "IKEv1 Policy object description", "id": "ikev1policyUUID", "type": "IKEv1Policy" }, { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID" }, "priority": 20, "lifetimeInSeconds": 86400, "diffieHellmanGroup": 5, "authenticationMethod": "Preshared Key", "encryption": "AES-128", "hash": "SHA", "name": "ikev1policy-2", "description": "IKEv1 Policy object description", "id": "ikev1policyUUID", "type": "IKEv1Policy" } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createIkev1PolicyObject", "description": "**Retrieves, deletes, creates, or modifies the IKEv1 policy object associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv1 policy objects. _Check the response section for applicable examples (if any)._**", "operationId": "createIkev1PolicyObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of IKEv1 policy object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ikev1PolicyObject" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ikev1PolicyObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/ikev1policies/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getIkev1PolicyObject", "description": "**Retrieves, deletes, creates, or modifies the IKEv1 policy object associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv1 policy objects.**", "operationId": "getIkev1PolicyObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for IKEv1 policy object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ikev1PolicyObject" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID" }, "priority": 20, "lifetimeInSeconds": 86400, "diffieHellmanGroup": 5, "authenticationMethod": "Preshared Key", "encryption": "AES-128", "hash": "SHA", "name": "ikev1_object", "description": "Get ikev1 policy object by id", "id": "ikev1policyUUID", "type": "IKEv1Policy" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateIkev1PolicyObject", "description": "**Retrieves, deletes, creates, or modifies the IKEv1 policy object associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv1 policy objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateIkev1PolicyObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for IKEv1 policy object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of IKEv1 policy object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ikev1PolicyObject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ikev1PolicyObject" }, "example": { "name": "ikev1policy-test-1", "id": "ikev1policyUUID", "priority": 20, "lifetimeInSeconds": 86400, "diffieHellmanGroup": 5, "authenticationMethod": "Preshared Key", "encryption": "AES-128", "hash": "SHA", "type": "IKEv1Policy", "description": "IKEv1 Policy object description" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteIkev1PolicyObject", "description": "**Retrieves, deletes, creates, or modifies the IKEv1 policy object associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv1 policy objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteIkev1PolicyObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for IKEv1 policy object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ikev1PolicyObject" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID", "parent": "/api/fmc_config/v1/domain/DomainUUID/object/ikev1policies" }, "name": "ikev1policy-test-1", "id": "ikev1policyUUID", "priority": 20, "lifetimeInSeconds": 86400, "diffieHellmanGroup": 5, "authenticationMethod": "Preshared Key", "encryption": "AES-128", "hash": "SHA", "type": "IKEv1Policy", "description": "IKEv1 Policy object description" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/ikev2ipsecproposals": { "get": { "tags": [ "Object" ], "summary": "getAllIKEv2IPsecProposal", "description": "**Retrieves, deletes, creates, or modifies the IKEv2 IPSec Proposal associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv2 IPSec Proposal objects.**", "operationId": "getAllIKEv2IPsecProposal", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEv2IPsecProposalListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals?offset=0&limit=2" }, "items": [ { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID" }, "name": "ikev2ipsecproposal-1", "id": "ikev2ipsecproposalUUID", "type": "IKEv2IPsecProposal" }, { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID" }, "name": "ikev2ipsecproposal-2", "id": "ikev2ipsecproposalUUID", "type": "IKEv2IPsecProposal" } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createIKEv2IPsecProposal", "description": "**Retrieves, deletes, creates, or modifies the IKEv2 IPSec Proposal associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv2 IPSec Proposal objects. _Check the response section for applicable examples (if any)._**", "operationId": "createIKEv2IPsecProposal", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of IKEv2 IPSec Proposal object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEv2IPsecProposal" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEv2IPsecProposal" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/ikev2ipsecproposals/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getIKEv2IPsecProposal", "description": "**Retrieves, deletes, creates, or modifies the IKEv2 IPSec Proposal associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv2 IPSec Proposal objects.**", "operationId": "getIKEv2IPsecProposal", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for IKEv2 IPSec Proposal object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEv2IPsecProposal" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID" }, "encryptionAlgorithms": [ "3DES", "AES-192" ], "integrityAlgorithms": [ "SHA-256", "SHA-512" ], "name": "ikev2ipsecproposal-1", "description": "IKEv2 IPsec Proposal object description", "id": "ikev2ipsecproposalUUID", "type": "IKEv2IPsecProposal" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateIKEv2IPsecProposal", "description": "**Retrieves, deletes, creates, or modifies the IKEv2 IPSec Proposal associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv2 IPSec Proposal objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateIKEv2IPsecProposal", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for IKEv2 IPSec Proposal object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of IKEv2 IPSec Proposal object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEv2IPsecProposal" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEv2IPsecProposal" }, "example": { "name": "ikev2ipsecproposal-test-1", "id": "ikev2ipsecproposalUUID", "encryptionAlgorithms": [ "3DES" ], "integrityAlgorithms": [ "SHA-256" ], "type": "IKEv2IPsecProposal", "description": "IKEv2 IPsec object description" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteIKEv2IPsecProposal", "description": "**Retrieves, deletes, creates, or modifies the IKEv2 IPSec Proposal associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv2 IPSec Proposal objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteIKEv2IPsecProposal", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for IKEv2 IPSec Proposal object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEv2IPsecProposal" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID", "parent": "/api/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals" }, "name": "ikev2ipsecproposal-test-1", "id": "ikev2ipsecproposalUUID", "encryptionAlgorithms": [ "3DES", "AES-192" ], "integrityAlgorithms": [ "SHA-256", "SHA-512" ], "type": "IKEv2IPsecProposal", "description": "IKEv2 IPsec object description" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/ikev2policies": { "get": { "tags": [ "Object" ], "summary": "getAllIkev2PolicyObject", "description": "**Retrieves, deletes, creates, or modifies the IKEv2 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv2 monitor objects.**", "operationId": "getAllIkev2PolicyObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ikev2PolicyObjectListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/default/object/ikev2policies?expanded=true" }, "items": [ { "links": { "self": "https:///api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/ikev2policies/005056A9-5C7D-0ed3-0000-000000000400" }, "priority": 10, "type": "Ikev2Policy", "lifetimeInSeconds": 86400, "encryptionAlgorithms": [ "AES-GCM", "AES-GCM-192", "AES-GCM-256" ], "integrityAlgorithms": [ "NULL" ], "prfIntegrityAlgorithms": [ "SHA", "SHA-256", "SHA-384", "SHA-512" ], "diffieHellmanGroups": [ 5, 14, 19, 20, 21 ], "name": "AES-GCM-NULL-SHA", "description": " ", "id": "005056A9-5C7D-0ed3-0000-000000000400" }, { "links": { "self": "https:///api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/ikev2policies/005056A9-5C7D-0ed3-0000-000000000401" }, "priority": 20, "type": "Ikev2Policy", "lifetimeInSeconds": 86400, "encryptionAlgorithms": [ "AES", "AES-192", "AES-256" ], "integrityAlgorithms": [ "SHA", "SHA-256", "SHA-384", "SHA-512" ], "prfIntegrityAlgorithms": [ "SHA", "SHA-256", "SHA-384", "SHA-512" ], "diffieHellmanGroups": [ 5, 14, 20, 21, 24 ], "name": "AES-SHA-SHA", "description": " ", "id": "005056A9-5C7D-0ed3-0000-000000000401" }, { "links": { "self": "https:///api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/ikev2policies/005056A9-5C7D-0ed3-0000-081604378664" }, "priority": 10, "type": "Ikev2Policy", "lifetimeInSeconds": 86400, "encryptionAlgorithms": [ "AES-GCM", "AES-GCM-192", "AES-GCM-256" ], "integrityAlgorithms": [ "NULL" ], "prfIntegrityAlgorithms": [ "SHA", "SHA-256", "SHA-384", "SHA-512" ], "diffieHellmanGroups": [ 5, 14, 19, 20, 21 ], "name": "api_ike2", "description": " ", "id": "005056A9-5C7D-0ed3-0000-081604378664" }, { "links": { "self": "https:///api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/ikev2policies/005056A9-5C7D-0ed3-0000-000000000402" }, "priority": 80, "type": "Ikev2Policy", "lifetimeInSeconds": 86400, "encryptionAlgorithms": [ "DES" ], "integrityAlgorithms": [ "SHA" ], "prfIntegrityAlgorithms": [ "SHA" ], "diffieHellmanGroups": [ 5 ], "name": "DES-SHA-SHA", "description": " ", "id": "005056A9-5C7D-0ed3-0000-000000000402" } ], "paging": { "offset": 0, "limit": 4, "count": 4, "pages": 1 }, "expectStatus": 200, "expectHeaderContains": [ { "content-type": "application/json" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createIkev2PolicyObject", "description": "**Retrieves, deletes, creates, or modifies the IKEv2 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv2 monitor objects. _Check the response section for applicable examples (if any)._**", "operationId": "createIkev2PolicyObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of IKEv2 object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ikev2PolicyObject" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ikev2PolicyObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/ikev2policies/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getIkev2PolicyObject", "description": "**Retrieves, deletes, creates, or modifies the IKEv2 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv2 monitor objects.**", "operationId": "getIkev2PolicyObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for IKEv2 monitor object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ikev2PolicyObject" }, "example": { "links": { "self": "/fmc_config/v1/domain/default/object/ikev2policies?offset=0&limit=2" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/default/object/ikev2policies/ikev2Object1UUID" }, "type": "Ikev2Policy", "id": "ikev2Object1UUID", "name": "ikev2_test" }, { "links": { "self": "/fmc_config/v1/domain/default/object/ikev2policies/ikev2Object2UUID" }, "type": "Ikev2Policy", "id": "ikev2Object2UUID", "name": "ikev2_test2" } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateIkev2PolicyObject", "description": "**Retrieves, deletes, creates, or modifies the IKEv2 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv2 monitor objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateIkev2PolicyObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for IKEv2 monitor object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of IKEv2 object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ikev2PolicyObject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ikev2PolicyObject" }, "example": { "id": "005056A9-5C7D-0ed3-0000-081604379285", "priority": 12, "type": "Ikev2Policy", "lifetimeInSeconds": 86400, "encryptionAlgorithms": [ "AES-GCM", "AES-GCM-192", "AES-GCM-256" ], "integrityAlgorithms": [ "NULL" ], "prfIntegrityAlgorithms": [ "SHA", "SHA-256", "SHA-384", "SHA-512" ], "diffieHellmanGroups": [ 5, 14, 19, 20, 21 ], "name": "api_ike22", "description": " " } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteIkev2PolicyObject", "description": "**Retrieves, deletes, creates, or modifies the IKEv2 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv2 monitor objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteIkev2PolicyObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for IKEv2 monitor object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ikev2PolicyObject" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/ikev2policies/ikev2ObjectUUID" }, "priority": 12, "type": "Ikev2Policy", "lifetimeInSeconds": 86400, "encryptionAlgorithms": [ "AES-GCM", "AES-GCM-192", "AES-GCM-256" ], "integrityAlgorithms": [ "NULL" ], "prfIntegrityAlgorithms": [ "SHA", "SHA-256", "SHA-384", "SHA-512" ], "diffieHellmanGroups": [ 5, 14, 19, 20, 21 ], "name": "api_ike22", "id": "005056A9-5C7D-0ed3-0000-081604379285", "metadata": { "timestamp": 1517283234730, "lastUser": { "name": "gp1" }, "domain": { "name": "Global", "id": "e276abec-e0f2-11e3-8169-6d9ed49b625f" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/interfacegroups": { "get": { "tags": [ "Object" ], "summary": "getAllInterfaceGroupObject", "description": "**Retrieves, deletes, creates, or modifies the Interface group objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all interface group objects.**", "operationId": "getAllInterfaceGroupObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceGroupObjectListContainer" }, "example": { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfacegroups?offset=0&limit=2" }, "items": [ { "name": "Test2", "id": "Interface-group-UUID-2", "type": "InterfaceGroup", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfacegroups/Interface-group-UUID-2", "parent": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/" } }, { "name": "Test1", "id": "Interface-group-UUID-3", "type": "InterfaceGroup", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfacegroups/Interface-group-UUID-3", "parent": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/" } } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createInterfaceGroupObject", "description": "**Retrieves, deletes, creates, or modifies the Interface group objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all interface group objects. _Check the response section for applicable examples (if any)._**", "operationId": "createInterfaceGroupObject", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for interface group objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input interface group object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceGroupObject" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceGroupObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/interfacegroups/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getInterfaceGroupObject", "description": "**Retrieves, deletes, creates, or modifies the Interface group objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all interface group objects.**", "operationId": "getInterfaceGroupObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceGroupObject" }, "example": { "name": "InterfaceGroupObject5", "id": "Interface-group-UUID-1", "type": "InterfaceGroup", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfacegroups/Interface-group-UUID-1", "parent": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/" }, "metadata": { "timestamp": 1459973987, "readOnly": { "state": true }, "domain": { "id": "domainUUID", "type": "Domain", "name": "Global" }, "lastUser": { "name": "admin", "id": "User-UUID", "type": "User" } }, "interfaceMode": "INLINE", "interfaces": [ { "type": "FPPhysicalInterface", "id": "Intf-UUID-1", "name": "eth1" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateInterfaceGroupObject", "description": "**Retrieves, deletes, creates, or modifies the Interface group objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all interface group objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateInterfaceGroupObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input interface group object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceGroupObject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceGroupObject" }, "example": { "type": "InterfaceGroup", "name": "InterfaceGroupObject5", "id": "Interface-group-UUID-1", "interfaceMode": "INLINE", "interfaces": [ { "type": "FPPhysicalInterface", "id": "Intf-UUID-1", "name": "eth1" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteInterfaceGroupObject", "description": "**Retrieves, deletes, creates, or modifies the Interface group objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all interface group objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteInterfaceGroupObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceGroupObject" }, "example": { "name": "InterfaceGroupObject5", "id": "Interface-group-UUID-1", "type": "InterfaceGroup", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfacegroups/Interface-group-UUID-1", "parent": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/" }, "metadata": { "timestamp": 1459973987, "readOnly": { "state": true }, "domain": { "id": "domainUUID", "type": "Domain", "name": "Global" }, "lastUser": { "name": "admin", "id": "User-UUID", "type": "User" }, "parentType": "InterfaceObject" }, "interfaceMode": "INLINE", "interfaces": [ { "type": "FPPhysicalInterface", "id": "Intf-UUID-1", "name": "eth1" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/interfaceobjects": { "get": { "tags": [ "Object" ], "summary": "getAllInterfaceObject", "description": "**Retrieves list of all the interface objects both security zones and interface groups.**", "operationId": "getAllInterfaceObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceObjectListContainer" }, "example": { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfaceobjects?offset=0&limit=2" }, "items": [ { "name": "Test2", "id": "Interface-obj-UUID-2", "type": "InterfaceGroup", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfaceobjects/Interface-obj-UUID-2" } }, { "name": "Test1", "id": "Interface-obj-UUID-3", "type": "InterfaceGroup", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfacegroups/Interface-obj-UUID-3", "parent": "https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfaceobjects/" } } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/interfaceobjects/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getInterfaceObject", "description": "**Retrieves list of all the interface objects both security zones and interface groups.**", "operationId": "getInterfaceObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/isesecuritygrouptags": { "get": { "tags": [ "Object" ], "summary": "getAllISESecurityGroupTag", "description": "**Retrieves the ISE security group tag object with the specified ID. If no ID is specified, retrieves list of all ISE security group tag objects.**", "operationId": "getAllISESecurityGroupTag", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISESecurityGroupTagListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/isesecuritygrouptags/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getISESecurityGroupTag", "description": "**Retrieves the ISE security group tag object with the specified ID. If no ID is specified, retrieves list of all ISE security group tag objects.**", "operationId": "getISESecurityGroupTag", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the ISE security group tag object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISESecurityGroupTag" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/keychains": { "get": { "tags": [ "Object" ], "summary": "getAllKeyChainObject", "description": "**Retrieves, deletes, creates, or modifies the Keychain object associated with the specified ID. If no ID is specified for a GET, retrieves list of all Keychain objects.**", "operationId": "getAllKeyChainObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyChainObjectListContainer" }, "example": { "links": { "self": "api/fmc_config/v1/domain/DomainUUID/object/keychain?offset=0&limit=3" }, "items": [ { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID" }, "type": "KeyChainObject", "name": "KeyChainObjectName1", "id": "KeyChainUUID" }, { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID" }, "type": "KeyChainObject", "name": "KeyChainObjectName2", "id": "KeyChainUUID" }, { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID" }, "type": "KeyChainObject", "name": "KeyChainObjectName3", "id": "KeyChainUUID" } ], "paging": { "offset": 0, "limit": 3, "count": 3, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createKeyChainObject", "description": "**Retrieves, deletes, creates, or modifies the Keychain object associated with the specified ID. If no ID is specified for a GET, retrieves list of all Keychain objects. _Check the response section for applicable examples (if any)._**", "operationId": "createKeyChainObject", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for KeyChain objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of KeyChain object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyChainObject" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyChainObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/keychains/{containerUUID}/overrides": { "get": { "tags": [ "Object" ], "summary": "getAllKeyChainObjectOverride", "description": "**Retrieves all(Domain and Device) overrides on a KeyChain object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getAllKeyChainObjectOverride", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyChainObjectOverrideListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/keychain/keyChainUUID/overrides?offset=0&limit=1" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/keychain/keyChainUUID?overrideTargetId=targetUUID" }, "keys": [ { "keyId": 1, "authString": { "cryptoEncryptionType": "PLAINTEXT", "cryptoKeyString": "keyString" }, "acceptLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DATETIME", "endLifeTimeValue": "2018-08-27T12:14:23" }, "sendLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DATETIME", "endLifeTimeValue": "2018-08-27T12:14:23" }, "authAlgorithm": "md5" }, { "keyId": 2, "authString": { "cryptoEncryptionType": "PLAINTEXT", "cryptoKeyString": "keyString" }, "acceptLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DATETIME", "endLifeTimeValue": "2018-08-27T12:14:23" }, "sendLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DURATION", "endLifeTimeValue": "234" }, "authAlgorithm": "md5" } ], "type": "KeyChainObject", "name": "KeyChainObjectName1", "id": "KeyChainUUID", "description": "description for keychain object", "overrides": { "parent": { "id": "KeyChainUUID", "type": "KeyChainObject" }, "target": { "name": "10.10.9.20", "id": "deviceUUID", "type": "Device" } }, "overridable": true, "metadata": { "timestamp": 1520419867090, "lastUser": { "name": "user1" }, "domain": { "name": "Global \\ INDIA \\ BENGALURU", "id": "domainUUID" } } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/keychains/{containerUUID}/overrides/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getKeyChainObjectOverride", "description": "**Retrieves all(Domain and Device) overrides on a KeyChain object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getKeyChainObjectOverride", "parameters": [ { "name": "objectId", "in": "path", "description": "Input NOT Expected here", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyChainObjectOverride" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/keychains/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getKeyChainObject", "description": "**Retrieves, deletes, creates, or modifies the Keychain object associated with the specified ID. If no ID is specified for a GET, retrieves list of all Keychain objects.**", "operationId": "getKeyChainObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for KeyChain object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "overrideTargetId", "in": "query", "description": "Retrieves the override(s) associated with the KeyChain object on given target ID.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyChainObject" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID" }, "keys": [ { "keyId": 1, "authString": { "cryptoEncryptionType": "PLAINTEXT", "cryptoKeyString": "keyString" }, "acceptLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DATETIME", "endLifeTimeValue": "2018-08-27T12:14:23" }, "sendLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DATETIME", "endLifeTimeValue": "2018-08-27T12:14:23" }, "authAlgorithm": "md5" }, { "keyId": 2, "authString": { "cryptoEncryptionType": "PLAINTEXT", "cryptoKeyString": "keyString" }, "acceptLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DATETIME", "endLifeTimeValue": "2018-08-27T12:14:23" }, "sendLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DURATION", "endLifeTimeValue": "234" }, "authAlgorithm": "md5" } ], "type": "KeyChainObject", "name": "KeyChainObjectName1", "id": "KeyChainUUID", "description": "description for keychain object", "overridable": false, "metadata": { "timestamp": 1523597066886, "lastUser": { "name": "rest" }, "domain": { "name": "Global", "id": "DomainUUID" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateKeyChainObject", "description": "**Retrieves, deletes, creates, or modifies the Keychain object associated with the specified ID. If no ID is specified for a GET, retrieves list of all Keychain objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateKeyChainObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for KeyChain object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of KeyChain object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyChainObject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyChainObject" }, "example": { "keys": [ { "keyId": 1, "authString": { "cryptoEncryptionType": "PLAINTEXT", "cryptoKeyString": "keyString" }, "acceptLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DATETIME", "endLifeTimeValue": "2018-08-27T12:14:23" }, "sendLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DATETIME", "endLifeTimeValue": "2018-08-27T12:14:23" }, "authAlgorithm": "md5" }, { "keyId": 2, "authString": { "cryptoEncryptionType": "PLAINTEXT", "cryptoKeyString": "keyString" }, "acceptLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DATETIME", "endLifeTimeValue": "2018-08-27T12:14:23" }, "sendLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DURATION", "endLifeTimeValue": "234" }, "authAlgorithm": "md5" } ], "type": "KeyChainObject", "name": "KeyChainObjectName1", "description": "description for keychain object", "overridable": false, "id": "KeyChainUUID" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteKeyChainObject", "description": "**Retrieves, deletes, creates, or modifies the Keychain object associated with the specified ID. If no ID is specified for a GET, retrieves list of all Keychain objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteKeyChainObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for KeyChain object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyChainObject" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID" }, "keys": [ { "keyId": 1, "authString": { "cryptoEncryptionType": "PLAINTEXT", "cryptoKeyString": "keyString" }, "acceptLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DATETIME", "endLifeTimeValue": "2018-08-27T12:14:23" }, "sendLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DATETIME", "endLifeTimeValue": "2018-08-27T12:14:23" }, "authAlgorithm": "md5" }, { "keyId": 2, "authString": { "cryptoEncryptionType": "PLAINTEXT", "cryptoKeyString": "keyString" }, "acceptLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DATETIME", "endLifeTimeValue": "2018-08-27T12:14:23" }, "sendLifeTime": { "startLifeTimeValue": "2018-08-25T12:14:23", "endLifetimeType": "DURATION", "endLifeTimeValue": "234" }, "authAlgorithm": "md5" } ], "type": "KeyChainObject", "name": "KeyChainObjectName1", "id": "KeyChainUUID", "description": "description for keychain object", "metadata": { "timestamp": 1524129145233, "lastUser": { "name": "rest" }, "domain": { "name": "Global", "id": "DomainUUID" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/networkaddresses": { "get": { "tags": [ "Object" ], "summary": "getNetworkAddress", "description": "**Retrieves list of all network and host objects.**", "operationId": "getNetworkAddress", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkAddressListContainer" }, "example": { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses?offset=0&limit=19" }, "items": [ { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-1" }, "type": "Network", "name": "any", "id": "Network-UUID-1" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-2" }, "type": "Network", "name": "any-ipv4", "id": "Network-UUID-2" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-1" }, "type": "Host", "name": "any-ipv6", "id": "Host-UUID-1" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses//Network-UUID-3" }, "type": "Network", "name": "IPv4-Benchmark-Tests", "id": "Network-UUID-3" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-4" }, "type": "Network", "name": "IPv4-Link-Local", "id": "Network-UUID-4" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-5" }, "type": "Network", "name": "IPv4-Multicast", "id": "Network-UUID-5" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-6" }, "type": "Network", "name": "IPv4-Private-10.0.0.0-8", "id": "Network-UUID-6" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-7" }, "type": "Network", "name": "IPv4-Private-172.16.0.0-12", "id": "Network-UUID-7" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-8" }, "type": "Network", "name": "IPv4-Private-192.168.0.0-16", "id": "Network-UUID-8" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-9" }, "type": "Network", "name": "IPv6-IPv4-Mapped", "id": "Network-UUID-9" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-10" }, "type": "Network", "name": "IPv6-Link-Local", "id": "Network-UUID-10" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-11" }, "type": "Network", "name": "IPv6-Private-Unique-Local-Addresses", "id": "Network-UUID-11" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-12" }, "type": "Network", "name": "IPv6-to-IPv4-Relay-Anycast", "id": "Network-UUID-12" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-13" }, "type": "Network", "name": "NewTest", "id": "Network-UUID-13" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-14" }, "type": "Network", "name": "TestGlobal", "id": "Network-UUID-14" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-2" }, "type": "Host", "name": "TestHost", "id": "Host-UUID-2" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-3" }, "type": "Host", "name": "TestHost1", "id": "Host-UUID-3" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-4" }, "type": "Host", "name": "TestHostTestDomain", "id": "Host-UUID-4" }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-5" }, "type": "Network", "name": "TestTestDomain", "id": "Host-UUID-5" } ], "paging": { "offset": 0, "limit": 19, "count": 19, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/networkgroups": { "get": { "tags": [ "Object" ], "summary": "getAllNetworkGroup", "description": "**Retrieves, deletes, creates, or modifies the network group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all network group objects.**", "operationId": "getAllNetworkGroup", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkGroupListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createNetworkGroup", "description": "**Retrieves, deletes, creates, or modifies the network group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all network group objects. _Check the response section for applicable examples (if any)._**", "operationId": "createNetworkGroup", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for network group objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of network group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkGroup" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkGroup" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/networkgroups/{containerUUID}/overrides": { "get": { "tags": [ "Object" ], "summary": "getAllNetworkGroupOverride", "description": "**Retrieves all(Domain and Device) overrides on a NetworkGroup object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getAllNetworkGroupOverride", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkGroupOverrideListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/networkgroups/networkGroupUUID/overrides?offset=0&limit=1" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/networkgroups/networkGroupUUID?overrideTargetId=targetUUID" }, "type": "NetworkGroup", "objects": [ { "type": "Network", "name": "IPv4-Link-Local", "id": "networkUUID" } ], "overrides": { "parent": { "id": "networkGroupUUID", "type": "NetworkGroup" }, "target": { "name": "Global \\ INDIA \\ BENGALURU", "id": "targetUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "NW_Group", "id": "networkGroupUUID", "metadata": { "timestamp": 1520419016850, "lastUser": { "name": "user1" }, "domain": { "name": "Global \\ INDIA \\ BENGALURU", "id": "targetUUID" } } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/networkgroups/{containerUUID}/overrides/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getNetworkGroupOverride", "description": "**Retrieves all(Domain and Device) overrides on a NetworkGroup object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getNetworkGroupOverride", "parameters": [ { "name": "objectId", "in": "path", "description": "Input NOT Expected here", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkGroupOverride" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/networkgroups/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getNetworkGroup", "description": "**Retrieves, deletes, creates, or modifies the network group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all network group objects.**", "operationId": "getNetworkGroup", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for a network group.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "overrideTargetId", "in": "query", "description": "Retrieves the override(s) associated with the network group object on given target ID.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkGroup" }, "example": { "id": "networkGroup1UUID", "name": "networkgroup_obj1", "type": "NetworkGroup", "objects": [ { "type": "Network", "id": "NetworkObjectUUID", "name": "network_obj_name", "links": { "self": "link_to_network_obj" } }, { "type": "Host", "id": "HostObjectUUID", "name": "host_obj_name", "links": { "self": "link_to_host_obj" } }, { "type": "Range", "id": "RangeObjectUUID", "name": "range_obj_name", "links": { "self": "link_to_range_obj" } } ], "literals": [ { "type": "Network", "value": "1.2.3.0/24" }, { "type": "Host", "value": "1.2.3.4" } ], "metadata": { "lastUser": { "name": "admin" }, "domain": { "name": "Global", "id": "GlobalDomainUUID" } }, "links": { "self": "/fmc_config/v1/domain/global/object/networkgroups/networkGroupUUID" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateNetworkGroup", "description": "**Retrieves, deletes, creates, or modifies the network group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all network group objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateNetworkGroup", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for a network group.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of network group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkGroup" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkGroup" }, "example": { "id": "networkGroup1UUID", "name": "networkgroup_obj1_updated", "type": "NetworkGroup", "objects": [ { "type": "Network", "id": "NetworkObjectUUID" }, { "type": "Host", "id": "HostObjectUUID" }, { "type": "Range", "id": "RangeObjectUUID" } ], "literals": [ { "type": "Network", "value": "1.2.3.0/24" }, { "type": "Host", "value": "1.2.3.4" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteNetworkGroup", "description": "**Retrieves, deletes, creates, or modifies the network group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all network group objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteNetworkGroup", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for a network group.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkGroup" }, "example": { "id": "networkGroup1UUID", "name": "networkgroup_obj1", "type": "NetworkGroup", "objects": [ { "type": "Network", "id": "NetworkObjectUUID", "name": "network_obj_name", "links": { "self": "link_to_network_obj" } }, { "type": "Host", "id": "HostObjectUUID", "name": "host_obj_name", "links": { "self": "link_to_host_obj" } }, { "type": "Range", "id": "RangeObjectUUID", "name": "range_obj_name", "links": { "self": "link_to_range_obj" } } ], "literals": [ { "type": "Network", "value": "1.2.3.0/24" }, { "type": "Host", "value": "1.2.3.4" } ], "metadata": { "lastUser": { "name": "admin" }, "domain": { "name": "Global", "id": "GlobalDomainUUID" } }, "links": { "self": "/fmc_config/v1/domain/global/object/networkgroups/networkGroupUUID" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/networks": { "get": { "tags": [ "Object" ], "summary": "getAllNetworkObject", "description": "**Retrieves, deletes, creates, or modifies the network objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all network objects.**", "operationId": "getAllNetworkObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkObjectListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/networks?offset=0&limit=5" }, "items": [ { "name": "network_0", "type": "Network", "overridable": false }, { "name": "network_1", "type": "Network", "overridable": false }, { "name": "network_2", "type": "Network", "overridable": false }, { "name": "network_3", "type": "Network", "overridable": false }, { "name": "network_4", "type": "Network", "overridable": false } ], "paging": { "offset": 0, "limit": 5, "count": 10, "pages": 2, "next": [ "/fmc_config/v1/domain/DomainUUID/object/networks?offset=5&limit=5" ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createNetworkObject", "description": "**Retrieves, deletes, creates, or modifies the network objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all network objects. _Check the response section for applicable examples (if any)._**", "operationId": "createNetworkObject", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for network objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input network object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkObject" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/networks/{containerUUID}/overrides": { "get": { "tags": [ "Object" ], "summary": "getAllNetworkOverride", "description": "**Retrieves all(Domain and Device) overrides on a Network object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getAllNetworkOverride", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkOverrideListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/networks/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getNetworkObject", "description": "**Retrieves, deletes, creates, or modifies the network objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all network objects.**", "operationId": "getNetworkObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "overrideTargetId", "in": "query", "description": "Retrieves the override(s) associated with the network object on given target ID.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkObject" }, "example": { "links": { "self": "/fmc_config/v1/domain/global/object/hosts/networkObjectUUID", "parent": "/fmc_config/v1/domain/global/object/networkaddresses" }, "type": "Host", "value": "1.2.3.4", "overrides": { "parent": { "id": "networkObjectUUID", "type": "Host" }, "target": { "name": "Global \\ Asia", "id": "subDomainUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "pvs_global", "id": "networkObjectUUID", "metadata": { "lastUser": { "name": "pvs" }, "domain": { "name": "Global \\ Asia", "id": "subDomainUUID" }, "ipType": "V_4", "parentType": "NetworkAddress" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateNetworkObject", "description": "**Retrieves, deletes, creates, or modifies the network objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all network objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateNetworkObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input network object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkObject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkObject" }, "example": { "type": "Network", "value": "1.2.3.0/24", "overridable": false, "description": "Test Description", "id": "networkObjectUUID", "name": "network_obj_name" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteNetworkObject", "description": "**Retrieves, deletes, creates, or modifies the network objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all network objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteNetworkObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkObject" }, "example": { "links": { "self": "/fmc_config/v1/domain/global/object/networks/networkObjectUUID", "parent": "/fmc_config/v1/domain/global/object/networkaddresses" }, "type": "Network", "value": "1.2.3.0/24", "overridable": false, "description": "Test Description", "id": "networkObjectUUID", "name": "network_obj_name", "metadata": { "lastUser": { "name": "admin" }, "domain": { "name": "Global", "id": "GlobalDomainUUID" }, "ipType": "V_4", "parentType": "NetworkAddress" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/portobjectgroups": { "get": { "tags": [ "Object" ], "summary": "getAllPortObjectGroup", "description": "**Retrieves, deletes, creates, or modifies the port object group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all port object group objects.**", "operationId": "getAllPortObjectGroup", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortObjectGroupListContainer" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/domain_uuid/object/portobjectgroups?offset=0&limit=1&overrideTargetId=device_uuid&expanded=true" }, "items": [ { "metadata": { "timestamp": 1528178429136, "lastUser": { "name": "pvs" }, "domain": { "name": "Global \\ ASIA \\ INDIA", "id": "domain_uuid" }, "parentType": "Port" }, "links": { "self": "/api/fmc_config/v1/domain/domain_uuid/object/portobjectgroups/ppgrp1_uuid?overrideTargetId=device_uuid", "parent": "/api/fmc_config/v1/domain/domain_uuid/object/ports" }, "type": "PortObjectGroup", "objects": [ { "type": "ICMPV6Object", "code": 0, "icmpType": "3", "overridable": false, "id": "icmpv6_obj1_uuid", "name": "icmpv6_obj1" }, { "type": "ProtocolPortObject", "protocol": "TCP", "port": "123", "overridable": false, "id": "ppobj1_uuid", "name": "ppobj1" }, { "type": "ICMPV4Object", "code": 0, "icmpType": "3", "overridable": false, "id": "icmpv4_obj1_uuid", "name": "icmpv4_obj1" } ], "overrides": { "parent": { "id": "ppgrp1_uuid", "type": "PortObjectGroup" }, "target": { "name": "10.10.16.29", "id": "device_uuid", "type": "Device" } }, "overridable": true, "description": " ", "id": "ppgrp1_uuid", "name": "ppgrp1" } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createPortObjectGroup", "description": "**Retrieves, deletes, creates, or modifies the port object group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all port object group objects. _Check the response section for applicable examples (if any)._**", "operationId": "createPortObjectGroup", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for port group objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input port object group model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortObjectGroup" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortObjectGroup" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/portobjectgroups/{containerUUID}/overrides": { "get": { "tags": [ "Object" ], "summary": "getAllPortObjectGroupOverride", "description": "**Retrieves all(Domain and Device) overrides on a PortObjectGroup.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getAllPortObjectGroupOverride", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortObjectGroupOverrideListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/portobjectgroups/portObjectGroupUUID/overrides?offset=0&limit=1" }, "items": [ { "metadata": { "timestamp": 1520419055913, "lastUser": { "name": "user1" }, "domain": { "name": "Global \\ INDIA \\ PUNE", "id": "targetUUID" }, "parentType": "PortObject" }, "links": { "self": "/fmc_config/v1/domain/domainUUID/object/portobjectgroups/portObjectGroupUUID?overrideTargetId=targetUUID" }, "type": "PortObjectGroup", "objects": [ { "type": "ProtocolPortObject", "port": "6881-6889", "protocol": "TCP", "overridable": false, "name": "Bittorrent", "id": "ProtocolPortObjectUUID" } ], "overrides": { "parent": { "id": "portObjectGroupUUID", "type": "PortObjectGroup" }, "target": { "name": "Global \\ INDIA \\ PUNE", "id": "targetUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "PortGRP", "id": "portObjectGroupUUID" } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/portobjectgroups/{containerUUID}/overrides/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getPortObjectGroupOverride", "description": "**Retrieves all(Domain and Device) overrides on a PortObjectGroup.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getPortObjectGroupOverride", "parameters": [ { "name": "objectId", "in": "path", "description": "Input NOT Expected here", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortObjectGroupOverride" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/portobjectgroups/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getPortObjectGroup", "description": "**Retrieves, deletes, creates, or modifies the port object group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all port object group objects.**", "operationId": "getPortObjectGroup", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the port object group.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "overrideTargetId", "in": "query", "description": "Retrieves the override(s) associated with the port group object on given target ID.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortObjectGroup" }, "example": { "id": "PortGroupObjUUID", "name": "portgroup_obj1", "type": "PortObjectGroup", "objects": [ { "type": "ICMPV4Object", "id": "ICMPV4ObjectUUID" }, { "id": "ICMPV6ObjectUUID", "type": "ICMPV6Object" }, { "id": "ProtocolPortObjectUUID", "type": "ProtocolPortObject" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updatePortObjectGroup", "description": "**Retrieves, deletes, creates, or modifies the port object group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all port object group objects. _Check the response section for applicable examples (if any)._**", "operationId": "updatePortObjectGroup", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the port object group.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input port object group model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortObjectGroup" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortObjectGroup" }, "example": { "id": "PortGroupObjUUID", "name": "portgroup_obj1_updated", "type": "PortObjectGroup", "objects": [ { "type": "ICMPV4Object", "id": "ICMPV4ObjectUUID" }, { "id": "ICMPV6ObjectUUID", "type": "ICMPV6Object" }, { "id": "ProtocolPortObjectUUID", "type": "ProtocolPortObject" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deletePortObjectGroup", "description": "**Retrieves, deletes, creates, or modifies the port object group object associated with the specified ID. If no ID is specified for a GET, retrieves list of all port object group objects. _Check the response section for applicable examples (if any)._**", "operationId": "deletePortObjectGroup", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the port object group.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortObjectGroup" }, "example": { "id": "PortGroupObj2UUID", "name": "portgroup_obj2", "type": "PortObjectGroup", "objects": [ { "type": "ICMPV4Object", "id": "ICMPV4ObjectUUID" }, { "id": "ICMPV6ObjectUUID", "type": "ICMPV6Object" }, { "id": "ProtocolPortObjectUUID", "type": "ProtocolPortObject" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/ports": { "get": { "tags": [ "Object" ], "summary": "getPortObject", "description": "**Retrieves list of all port objects.**", "operationId": "getPortObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortObjectListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/protocolportobjects": { "get": { "tags": [ "Object" ], "summary": "getAllProtocolPortObject", "description": "**Retrieves, deletes, creates, or modifies the protocol(tcp/udp) port object associated with the specified ID. If no ID is specified for a GET, retrieves list of all protocol(tcp/udp) port objects.**", "operationId": "getAllProtocolPortObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolPortObjectListContainer" }, "example": { "links": { "self": "https://fmc_host_ip/api/fmc_config/v1/domain/childDomainUUID/object/protocolportobjects?offset=0&limit=1" }, "items": [ { "metadata": { "lastUser": { "name": "pvs" }, "domain": { "name": "Global \\ Asia", "id": "childDomainUUID" }, "parentType": "PortObject" }, "links": { "self": "https://fmc_host_ip/api/fmc_config/v1/domain/childDomainUUID/object/protocolportobjects/protocoPortObjUUID", "parent": "https://fmc_host_ip/api/fmc_config/v1/domain/childDomainUUID/object/ports" }, "type": "ProtocolPortObject", "protocol": "TCP", "port": "123", "overrides": { "parent": { "id": "protocoPortObjUUID", "type": "ProtocolPortObject" }, "target": { "name": "Global \\ Asia", "id": "childDomainUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "pvs_protocol", "id": "protocoPortObjUUID" } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createProtocolPortObject", "description": "**Retrieves, deletes, creates, or modifies the protocol(tcp/udp) port object associated with the specified ID. If no ID is specified for a GET, retrieves list of all protocol(tcp/udp) port objects. _Check the response section for applicable examples (if any)._**", "operationId": "createProtocolPortObject", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for protocol port objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input protocol port object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolPortObject" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolPortObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/protocolportobjects/{containerUUID}/overrides": { "get": { "tags": [ "Object" ], "summary": "getAllProtocolPortObjectOverride", "description": "**Retrieves all(Domain and Device) overrides on a ProtocolPort object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getAllProtocolPortObjectOverride", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolPortObjectOverrideListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/protocolportobjects/portUUID/overrides?offset=0&limit=2" }, "items": [ { "metadata": { "timestamp": 1520343176850, "lastUser": { "name": "user" }, "domain": { "name": "Global \\ INDIA", "id": "domainUUID" }, "parentType": "PortObject" }, "links": { "self": "/fmc_config/v1/domain/domainUUID/object/protocolportobjects/portUUID?overrideTargetId=targetUUID" }, "type": "ProtocolPortObject", "port": "5555", "protocol": "TCP", "overrides": { "parent": { "id": "portUUID", "type": "ProtocolPortObject" }, "target": { "name": "10.10.19.25", "id": "targetUUID", "type": "Device" } }, "overridable": true, "description": " ", "name": "protocol_port_1", "id": "portUUID" }, { "metadata": { "timestamp": 1520343161346, "lastUser": { "name": "user" }, "domain": { "name": "Global \\ BENGALURU", "id": "domainUUID" }, "parentType": "PortObject" }, "links": { "self": "/fmc_config/v1/domain/domainUUID/object/protocolportobjects/portUUID?overrideTargetId=targetUUID", "parent": "/fmc_config/v1/domain/domainUUID/object/protocolportobjects/portUUID/ports" }, "type": "ProtocolPortObject", "port": "2222", "protocol": "TCP", "overrides": { "parent": { "id": "portUUID", "type": "ProtocolPortObject" }, "target": { "name": "Global \\ BENGALURU", "id": "targetUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "protocol_port_1", "id": "portUUID" } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/protocolportobjects/{containerUUID}/overrides/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getProtocolPortObjectOverride", "description": "**Retrieves all(Domain and Device) overrides on a ProtocolPort object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getProtocolPortObjectOverride", "parameters": [ { "name": "objectId", "in": "path", "description": "Input NOT Expected here", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolPortObjectOverride" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/protocolportobjects/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getProtocolPortObject", "description": "**Retrieves, deletes, creates, or modifies the protocol(tcp/udp) port object associated with the specified ID. If no ID is specified for a GET, retrieves list of all protocol(tcp/udp) port objects.**", "operationId": "getProtocolPortObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "overrideTargetId", "in": "query", "description": "Retrieves the override(s) associated with the protocol port object on given target ID.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolPortObject" }, "example": { "id": "protocoPortObj1UUID", "name": "protocolport_obj1", "type": "ProtocolPortObject", "protocol": "TCP", "port": "123" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateProtocolPortObject", "description": "**Retrieves, deletes, creates, or modifies the protocol(tcp/udp) port object associated with the specified ID. If no ID is specified for a GET, retrieves list of all protocol(tcp/udp) port objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateProtocolPortObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input protocol port object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolPortObject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolPortObject" }, "example": { "id": "protocoPortObj1UUID", "name": "protocolport_obj1_updated", "type": "ProtocolPortObject", "protocol": "TCP", "port": "1" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteProtocolPortObject", "description": "**Retrieves, deletes, creates, or modifies the protocol(tcp/udp) port object associated with the specified ID. If no ID is specified for a GET, retrieves list of all protocol(tcp/udp) port objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteProtocolPortObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolPortObject" }, "example": { "id": "protocoPortObj2UUID", "name": "protocolport_obj2", "type": "ProtocolPortObject", "protocol": "TCP", "port": "123" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/ranges": { "get": { "tags": [ "Object" ], "summary": "getAllRangeObject", "description": "**Retrieves, deletes, creates, or modifies the address range object associated with the specified ID. If no ID is specified for a GET, retrieves list of all address range objects.**", "operationId": "getAllRangeObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RangeObjectListContainer" }, "example": { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/ranges?offset=0&limit=2" }, "items": [ { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/ranges/00505690-1DF7-0ed3-0000-236223201462", "parent": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses" }, "type": "Range", "value": "10.20.40.50-10.20.40.60", "overridable": false, "description": "Test1", "name": "Test1", "id": "00505690-1DF7-0ed3-0000-236223201462", "metadata": { "lastUser": { "name": "testuser" }, "domain": { "name": "Global", "id": "Global-domain-UUID" }, "ipType": "V_4", "parentType": "NetworkAddress" } }, { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/ranges/Range-obj-UUID-2", "parent": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses" }, "type": "Range", "value": "10.20.30.4-10.20.30.128", "overridable": false, "description": " ", "name": "TestRange", "id": "Range-obj-UUID-2", "metadata": { "lastUser": { "name": "testuser" }, "domain": { "name": "Global", "id": "Global-domain-UUID" }, "ipType": "V_4", "parentType": "NetworkAddress" } } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createRangeObject", "description": "**Retrieves, deletes, creates, or modifies the address range object associated with the specified ID. If no ID is specified for a GET, retrieves list of all address range objects. _Check the response section for applicable examples (if any)._**", "operationId": "createRangeObject", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for range objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of address range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RangeObject" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RangeObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/ranges/{containerUUID}/overrides": { "get": { "tags": [ "Object" ], "summary": "getAllRangeOverride", "description": "**Retrieves all(Domain and Device) overrides on a Range object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getAllRangeOverride", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RangeOverrideListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/ranges/rangeUUID/overrides?offset=0&limit=1" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/ranges/rangeUUID?overrideTargetId=targetUUID" }, "type": "Range", "value": "1.2.3.7-1.2.3.9", "overrides": { "parent": { "id": "rangeUUID", "type": "Range" }, "target": { "name": "Global \\ BENGALURU", "id": "targetUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "Range_1", "id": "rangeUUID", "metadata": { "timestamp": 1520336790963, "lastUser": { "name": "user1" }, "domain": { "name": "Global \\ BENGALURU", "id": "domainUUID" } } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/ranges/{containerUUID}/overrides/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getRangeOverride", "description": "**Retrieves all(Domain and Device) overrides on a Range object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getRangeOverride", "parameters": [ { "name": "objectId", "in": "path", "description": "Input NOT Expected here", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RangeOverride" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/ranges/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getRangeObject", "description": "**Retrieves, deletes, creates, or modifies the address range object associated with the specified ID. If no ID is specified for a GET, retrieves list of all address range objects.**", "operationId": "getRangeObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for address range.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "overrideTargetId", "in": "query", "description": "Retrieves the override(s) associated with the range object on given target ID.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RangeObject" }, "example": { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/ranges/Range-obj-UUID-1", "parent": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses" }, "type": "Range", "value": "2003::3-2003::4", "overridable": false, "description": "Test Description", "name": "TestRange2", "id": "Range-obj-UUID-1", "metadata": { "lastUser": { "name": "testuser" }, "domain": { "name": "Global \\ TestDomain", "id": "domainUUID" }, "ipType": "V_6", "parentType": "NetworkAddress" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateRangeObject", "description": "**Retrieves, deletes, creates, or modifies the address range object associated with the specified ID. If no ID is specified for a GET, retrieves list of all address range objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateRangeObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for address range.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of address range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RangeObject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RangeObject" }, "example": { "name": "TestRange2", "value": "2003::3-2003::4", "type": "Range", "description": "Test Description", "id": "Range-obj-UUID-1" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteRangeObject", "description": "**Retrieves, deletes, creates, or modifies the address range object associated with the specified ID. If no ID is specified for a GET, retrieves list of all address range objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteRangeObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for address range.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RangeObject" }, "example": { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/ranges/Range-obj-UUID-1", "parent": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses" }, "type": "Range", "value": "2003::3-2003::4", "overridable": false, "description": "Test Description", "name": "TestRange2", "id": "Range-obj-UUID-1", "metadata": { "lastUser": { "name": "testuser" }, "domain": { "name": "Global \\ TestDomain", "id": "domainUUID" }, "ipType": "V_6", "parentType": "NetworkAddress" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/realms": { "get": { "tags": [ "Object" ], "summary": "getAllRealm", "description": "**Retrieves the realm object associated with the specified ID. If no ID is specified, retrieves list of all realm objects.**", "operationId": "getAllRealm", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealmListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/realms?offset=0&limit=2" }, "items": [ { "type": "Realm", "id": "RealmUUID", "name": "Realm_2", "links": { "self": "/fmc_config/v1/domain/domainUUID/object/realms/RealmUUID" } }, { "type": "Realm", "id": "RealmUUID", "name": "Realm_3", "links": { "self": "/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/realms/RealmUUID" } } ], "paging": { "offset": 0, "limit": 2, "count": 5, "next": [ "/fmc_config/v1/domain/domainUUID/object/realms?offset=2&limit=2", "/fmc_config/v1/domain/domainUUID/object/realms?offset=4&limit=1" ], "pages": 3 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/realms/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getRealm", "description": "**Retrieves the realm object associated with the specified ID. If no ID is specified, retrieves list of all realm objects.**", "operationId": "getRealm", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of user realm.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Realm" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/realms/RealmUUID" }, "type": "Realm", "name": "Realm_1", "id": "RealmUUID", "metadata": { "count": 1094 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/realmusergroups": { "get": { "tags": [ "Object" ], "summary": "getAllRealmUserGroup", "description": "**Retrieves the realm user group object associated with the specified ID. If no ID is specified, retrieves list of all realm user group objects.**", "operationId": "getAllRealmUserGroup", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealmUserGroupListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/realmusergroups?offset=0&limit=2&realmId=RealmUUID" }, "items": [ { "type": "RealmUserGroup", "id": "RealmUUID_RealmUserGroupUUID", "name": "Low", "links": { "self": "/fmc_config/v1/domain/domainUUID/object/realmusergroups/RealmUUID_RealmUserGroupUUID" } }, { "type": "RealmUserGroup", "id": "RealmUUID_RealmUserGroupUUID", "name": "Medium", "links": { "self": "/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/realmusergroups/RealmUUID_RealmUserGroupUUID" } } ], "paging": { "offset": 0, "limit": 2, "count": 5, "next": [ "/fmc_config/v1/domain/domainUUID/object/realmusergroups?offset=2&limit=2", "/fmc_config/v1/domain/domainUUID/object/realmusergroups?offset=4&limit=1" ], "pages": 3 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/realmusergroups/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getRealmUserGroup", "description": "**Retrieves the realm user group object associated with the specified ID. If no ID is specified, retrieves list of all realm user group objects.**", "operationId": "getRealmUserGroup", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of user groups.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "realmUuid", "in": "query", "description": "The Realm UUID.", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealmUserGroup" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/realmusergroups/RealmUUID_RealmUserGroupUUID" }, "type": "RealmUserGroup", "name": "Realm user group name", "id": "RealmUUID_RealmUserGroupUUID", "realm": { "id": "RealmUUID", "type": "Realm", "name": "realm name" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/realmusers": { "get": { "tags": [ "Object" ], "summary": "getAllRealmUser", "description": "**Retrieves the realm user object associated with the specified ID. If no ID is specified, retrieves list of all realm user objects.**", "operationId": "getAllRealmUser", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealmUserListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/realmusers?offset=0&limit=2&realmId=RealmUUID" }, "items": [ { "type": "RealmUser", "id": "RealmUUID_RealmUserUUID", "name": "Low", "links": { "self": "/fmc_config/v1/domain/domainUUID/object/realmusers/RealmUUID_RealmUserUUID" } }, { "type": "RealmUser", "id": "RealmUUID_RealmUserUUID", "name": "Medium", "links": { "self": "/fmc_config/v1/domain/domainUUID/object/realmusers/RealmUUID_RealmUserUUID" } } ], "paging": { "offset": 0, "limit": 2, "count": 5, "next": [ "/fmc_config/v1/domain/domainUUID/object/realmusers?offset=2&limit=2", "/fmc_config/v1/domain/domainUUID/object/realmusers?offset=4&limit=1" ], "pages": 3 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/realmusers/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getRealmUser", "description": "**Retrieves the realm user object associated with the specified ID. If no ID is specified, retrieves list of all realm user objects.**", "operationId": "getRealmUser", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of user.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "realmUuid", "in": "query", "description": "The Realm UUID.", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealmUser" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/realmusers/RealmUUID_RealmUserUUID" }, "type": "RealmUser", "name": "Realm Name_3", "id": "RealmUUID_RealmUserUUID", "realm": { "id": "RealmUUID", "type": "Realm", "name": "realm name" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/securitygrouptags": { "get": { "tags": [ "Object" ], "summary": "getAllSecurityGroupTag", "description": "**Retrieves the custom security group tag object associated with the specified ID. If no ID is specified, retrieves list of all custom security group tag objects.**", "operationId": "getAllSecurityGroupTag", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityGroupTagListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/securitygrouptags/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getSecurityGroupTag", "description": "**Retrieves the custom security group tag object associated with the specified ID. If no ID is specified, retrieves list of all custom security group tag objects.**", "operationId": "getSecurityGroupTag", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the security group tag object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityGroupTag" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/securityzones": { "get": { "tags": [ "Object" ], "summary": "getAllSecurityZoneObject", "description": "**Retrieves, deletes, creates, or modifies the security zone objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all security zone objects.**", "operationId": "getAllSecurityZoneObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityZoneObjectListContainer" }, "example": { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/default/object/securityzones?offset=0&limit=2" }, "items": [ { "name": "Test2", "id": "Sec-zone-UUID-2", "type": "SecurityZone", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/default/object/securityzones/Sec-zone-UUID-2", "parent": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/" }, "metadata": { "readOnly": { "state": true }, "timestamp": 1459973987, "lastUser": { "name": "admin", "id": "User-UUID", "type": "user" }, "domain": { "name": "Global", "id": "domainUUID", "type": "domain" }, "parentType": "InterfaceObject" }, "interfaceMode": "ASA", "interfaces": [ { "type": "FPPhysicalInterface", "id": "Intf-UUID-3", "name": "outside" }, { "type": "FPPhysicalInterface", "id": "Intf-UUID-4", "name": "inside" } ] }, { "name": "Test1", "id": "Sec-zone-UUID-3", "type": "SecurityZone", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/default/object/securityzones/Sec-zone-UUID-3", "parent": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/" }, "metadata": { "readOnly": { "state": true }, "timestamp": 1459973857, "lastUser": { "name": "admin", "id": "User-UUID", "type": "user" }, "domain": { "name": "Global", "id": "domainUUID", "type": "domain" }, "parentType": "InterfaceObject" }, "interfaceMode": "INLINE", "interfaces": [ { "type": "FPPhysicalInterface", "id": "Intf-UUID-5", "name": "s1p2" }, { "type": "FPPhysicalInterface", "id": "Intf-UUID-6", "name": "s1p1" } ] } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createSecurityZoneObject", "description": "**Retrieves, deletes, creates, or modifies the security zone objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all security zone objects. _Check the response section for applicable examples (if any)._**", "operationId": "createSecurityZoneObject", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for security zone objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input security zone object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityZoneObject" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityZoneObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/securityzones/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getSecurityZoneObject", "description": "**Retrieves, deletes, creates, or modifies the security zone objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all security zone objects.**", "operationId": "getSecurityZoneObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityZoneObject" }, "example": { "name": "SecurityZoneObject5", "id": "Sec-zone-UUID-1", "type": "SecurityZone", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/securityzones/Sec-zone-UUID-1", "parent": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/" }, "metadata": { "timestamp": 1459973987, "readOnly": { "state": true }, "domain": { "id": "domainUUID", "type": "Domain", "name": "Global" }, "lastUser": { "name": "admin", "id": "User-UUID", "type": "User" }, "parentType": "InterfaceObject" }, "interfaceMode": "INLINE", "interfaces": [ { "type": "FPPhysicalInterface", "id": "Intf-UUID-1", "name": "eth1" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateSecurityZoneObject", "description": "**Retrieves, deletes, creates, or modifies the security zone objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all security zone objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateSecurityZoneObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input security zone object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityZoneObject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityZoneObject" }, "example": { "type": "SecurityZone", "name": "SecurityZoneObject5", "id": "Sec-zone-UUID-1", "interfaceMode": "INLINE", "interfaces": [ { "type": "FPPhysicalInterface", "id": "Intf-UUID-1", "name": "eth1" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteSecurityZoneObject", "description": "**Retrieves, deletes, creates, or modifies the security zone objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all security zone objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteSecurityZoneObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityZoneObject" }, "example": { "name": "SecurityZoneObject5", "id": "Sec-zone-UUID-1", "type": "SecurityZone", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/securityzones/Sec-zone-UUID-1", "parent": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/" }, "metadata": { "timestamp": 1459973987, "readOnly": { "state": true }, "domain": { "id": "domainUUID", "type": "Domain", "name": "Global" }, "lastUser": { "name": "admin", "id": "User-UUID", "type": "User" }, "parentType": "InterfaceObject" }, "interfaceMode": "INLINE", "interfaces": [ { "type": "FPPhysicalInterface", "id": "Intf-UUID-1", "name": "eth1" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/siurlfeeds": { "get": { "tags": [ "Object" ], "summary": "getAllSIURLFeed", "description": "**Retrieves the Security Intelligence url feed object associated with the specified ID. If no ID is specified, retrieves list of all Security Intelligence url feed objects.**", "operationId": "getAllSIURLFeed", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIURLFeedListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/siurlfeeds?offset=0&limit=2" }, "items": [ { "name": "testing", "type": "SIURLFeed", "id": "SIURLFeedId", "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/siurlfeeds/SIURLFeedId" } }, { "name": "testing2", "type": "SIURLFeed", "id": "SIURLFeedId", "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/siurlfeeds/SIURLFeedId" } } ], "paging": { "offset": 0, "limit": 2, "count": 27, "next": [ "/fmc_config/v1/domain/DomainUUID/object/siurlfeeds?offset=2&limit=2", "/fmc_config/v1/domain/DomainUUID/object/siurlfeeds?offset=4&limit=2", "/fmc_config/v1/domain/DomainUUID/object/siurlfeeds?offset=6&limit=2", "/fmc_config/v1/domain/DomainUUID/object/siurlfeeds?offset=8&limit=2" ], "pages": 14 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/siurlfeeds/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getSIURLFeed", "description": "**Retrieves the Security Intelligence url feed object associated with the specified ID. If no ID is specified, retrieves list of all Security Intelligence url feed objects.**", "operationId": "getSIURLFeed", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier of Security Intelligence url feed object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIURLFeed" }, "example": { "type": "SIURLFeed", "id": "SIURLFeedId", "name": "URLFeed1", "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/siurlfeeds/SIURLFeedId" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/siurllists": { "get": { "tags": [ "Object" ], "summary": "getAllSIURLList", "description": "**Retrieves the Security Intelligence url list object associated with the specified ID. If no ID is specified, retrieves list of all Security Intelligence url list objects.**", "operationId": "getAllSIURLList", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIURLListListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/siurllists?offset=0&limit=2" }, "items": [ { "name": "Descendant-Blacklists-for-URL - Global", "type": "SIURLList", "id": "SIURLListId", "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListId" } }, { "name": "Descendant-Whitelists-for-URL - Global", "type": "SIURLList", "id": "SIURLListId", "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListId" } } ], "paging": { "offset": 0, "limit": 2, "count": 27, "next": [ "/fmc_config/v1/domain/DomainUUID/object/siurllists?offset=2&limit=2", "/fmc_config/v1/domain/DomainUUID/object/siurllists?offset=4&limit=2", "/fmc_config/v1/domain/DomainUUID/object/siurllists?offset=6&limit=2", "/fmc_config/v1/domain/DomainUUID/object/siurllists?offset=8&limit=2" ], "pages": 14 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/siurllists/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getSIURLList", "description": "**Retrieves the Security Intelligence url list object associated with the specified ID. If no ID is specified, retrieves list of all Security Intelligence url list objects.**", "operationId": "getSIURLList", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier of Security Intelligence url list object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIURLList" }, "example": { "type": "SIURLList", "id": "SIURLListId", "name": "URL", "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListId" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/slamonitors": { "get": { "tags": [ "Object" ], "summary": "getAllSLAMonitorObjectModel", "description": "**Retrieves, deletes, creates, or modifies the sla monitor object associated with the specified ID. If no ID is specified for a GET, retrieves list of all sla monitor objects.**", "operationId": "getAllSLAMonitorObjectModel", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLAMonitorObjectModelListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createSLAMonitorObjectModel", "description": "**Retrieves, deletes, creates, or modifies the sla monitor object associated with the specified ID. If no ID is specified for a GET, retrieves list of all sla monitor objects. _Check the response section for applicable examples (if any)._**", "operationId": "createSLAMonitorObjectModel", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for SLA monitor objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of sla monitor object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLAMonitorObjectModel" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLAMonitorObjectModel" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/slamonitors/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getSLAMonitorObjectModel", "description": "**Retrieves, deletes, creates, or modifies the sla monitor object associated with the specified ID. If no ID is specified for a GET, retrieves list of all sla monitor objects.**", "operationId": "getSLAMonitorObjectModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for sla monitor object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLAMonitorObjectModel" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/slamonitors/slaMonitorObjectUUID" }, "interfaceNames": [ "Interface1" ], "timeout": 5000, "type": "SLAMonitor", "threshold": 2, "frequency": 60, "slaId": 1, "dataSize": 28, "tos": 1, "noOfPackets": 1, "monitorAddress": "1.1.1.1", "interfaceObjects": [ { "name": "SecZone1", "id": "securityZoneUUID", "type": "SecurityZone" }, { "name": "InterfaceGroup1", "id": "interfaceGroupUUID", "type": "InterfaceGroup" } ], "description": "Sla monitor description", "name": "SLA1", "id": "slaMonitorObjectUUID" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateSLAMonitorObjectModel", "description": "**Retrieves, deletes, creates, or modifies the sla monitor object associated with the specified ID. If no ID is specified for a GET, retrieves list of all sla monitor objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateSLAMonitorObjectModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for sla monitor object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Input representation of sla monitor object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLAMonitorObjectModel" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLAMonitorObjectModel" }, "example": { "interfaceNames": [ "Interface1", "comment : For interfaceNames the only option in PUT is to remove these, no new additions of inline interface names will be allowed." ], "timeout": 5000, "type": "SLAMonitor", "threshold": 2, "frequency": 60, "slaId": 1, "dataSize": 28, "tos": 1, "noOfPackets": 1, "monitorAddress": "1.1.1.2", "interfaceObjects": [ { "name": "SecZone1", "id": "securityZoneUUID", "type": "SecurityZone" }, { "name": "InterfaceGroup1", "id": "interfaceGroupUUID", "type": "InterfaceGroup" } ], "description": "Sla monitor description updated", "name": "SLA1-Updated", "id": "slaMonitorObjectUUID" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteSLAMonitorObjectModel", "description": "**Retrieves, deletes, creates, or modifies the sla monitor object associated with the specified ID. If no ID is specified for a GET, retrieves list of all sla monitor objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteSLAMonitorObjectModel", "parameters": [ { "name": "objectId", "in": "path", "description": "Identifier for sla monitor object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLAMonitorObjectModel" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/DomainUUID/object/slamonitors/slaMonitorObjectUUID", "parent": "/api/fmc_config/v1/domain/DomainUUID/object/slamonitors" }, "interfaceNames": [ "Interface1" ], "timeout": 5000, "type": "SLAMonitor", "threshold": 2, "frequency": 60, "slaId": 1, "dataSize": 28, "tos": 1, "noOfPackets": 1, "monitorAddress": "1.1.1.1", "interfaceObjects": [ { "name": "SecZone1", "id": "securityZoneUUID", "type": "SecurityZone" }, { "name": "InterfaceGroup1", "id": "interfaceGroupUUID", "type": "InterfaceGroup" } ], "description": "Sla monitor description", "name": "SLA1", "id": "slaMonitorObjectUUID" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/tunneltags": { "get": { "tags": [ "Object" ], "summary": "getAllTunnelTags", "description": "**Retrieves the tunnel tag object associated with the specified ID. If no ID is specified, retrieves list of all tunnel tag objects.**", "operationId": "getAllTunnelTags", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TunnelTagsListContainer" }, "example": { "items": [ { "name": "TT_obj1", "id": "tunnelTagObj1UUID", "type": "TunnelTag", "links": { "self": "/fmc_config/v1/domain/domainUUID/object/tunneltags/tunnelTagObj1UUID" } }, { "name": "TT_obj2", "id": "tunnelTagObj2UUID", "type": "TunnelTag", "links": { "self": "/fmc_config/v1/domain/domainUUID/object/tunneltags/tunnelTagObj2UUID" } }, { "name": "TT_obj3", "id": "tunnelTagObj3UUID", "type": "TunnelTag", "links": { "self": "/fmc_config/v1/domain/domainUUID/object/tunneltags/tunnelTagObj3UUID" } } ], "paging": { "offset": 0, "limit": 3, "count": 3, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/tunneltags/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getTunnelTags", "description": "**Retrieves the tunnel tag object associated with the specified ID. If no ID is specified, retrieves list of all tunnel tag objects.**", "operationId": "getTunnelTags", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of a tunnel tag.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TunnelTags" }, "example": { "id": "tunnelTagObj1UUID", "name": "TT_obj1", "type": "TunnelTag", "description": "some description" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/urlcategories": { "get": { "tags": [ "Object" ], "summary": "getAllURLCategory", "description": "**Retrieves the url category object associated with the specified ID. If no ID is specified, retrieves list of all url category objects.**", "operationId": "getAllURLCategory", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLCategoryListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/urlcategories?offset=0&limit=2" }, "items": [ { "type": "URLCategory", "id": "urlCategoryUUID", "name": "Auctions", "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/urlcategories/urlCategoryUUID" } }, { "type": "URLCategory", "id": "urlCategoryUUID", "name": "Bot Nets", "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/urlcategories/urlCategoryUUID" } } ], "paging": { "offset": 0, "limit": 2, "count": 5, "next": [ "/fmc_config/v1/domain/DomainUUID/object/urlcategories?offset=2&limit=2", "/fmc_config/v1/domain/DomainUUID/object/urlcategories?offset=4&limit=29" ], "pages": 3 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/urlcategories/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getURLCategory", "description": "**Retrieves the url category object associated with the specified ID. If no ID is specified, retrieves list of all url category objects.**", "operationId": "getURLCategory", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLCategory" }, "example": { "type": "URLCategory", "id": "urlCategoryUUID", "name": "Auctions", "links": { "self": "/fmc_config/v1/domain/DomainUUID/object/urlcategories/urlCategoryUUID" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/urlgroups": { "get": { "tags": [ "Object" ], "summary": "getAllURLGroupObject", "description": "**Retrieves, deletes, creates, or modifies the url group objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all url group objects.**", "operationId": "getAllURLGroupObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLGroupObjectListContainer" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/domainUuid/object/urlgroups?offset=0&limit=1&overrideTargetId=device_uuid&expanded=true" }, "items": [ { "links": { "self": "/api/fmc_config/v1/domain/domainUuid/object/urlgroups/urlgrp1_uuid?overrideTargetId=device_uuid" }, "objects": [ { "type": "Url", "overridable": false, "id": "url1_uuid", "name": "url1" } ], "literals": [ { "url": "www.google.com", "type": "Url" } ], "type": "UrlGroup", "overrides": { "parent": { "id": "urlgrp1_uuid", "type": "UrlGroup" }, "target": { "name": "10.10.16.29", "id": "device_uuid", "type": "Device" } }, "overridable": true, "description": " ", "id": "urlgrp1_uuid", "name": "urlgrp1", "metadata": { "timestamp": 1528178384030, "lastUser": { "name": "pvs" }, "domain": { "name": "Global \\ ASIA \\ INDIA", "id": "domain_Uuid" } } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createURLGroupObject", "description": "**Retrieves, deletes, creates, or modifies the url group objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all url group objects. _Check the response section for applicable examples (if any)._**", "operationId": "createURLGroupObject", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for url group objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input url group object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLGroupObject" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLGroupObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/urlgroups/{containerUUID}/overrides": { "get": { "tags": [ "Object" ], "summary": "getAllUrlGroupOverride", "description": "**Retrieves all(Domain and Device) overrides on a URLGroup.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getAllUrlGroupOverride", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UrlGroupOverrideListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/urlgroups/urlGroupObjectUUID/overrides?offset=0&limit=1" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/urlgroups/urlGroupObjectUUID?overrideTargetId=793710a0-21cf-11e8-9b2b-c8519f5a7ccc" }, "type": "UrlGroup", "objects": [ { "type": "Url", "overridable": false, "name": "url_2", "id": "URLobjectUUID" } ], "overrides": { "parent": { "id": "UrlGroupUUID", "type": "UrlGroup" }, "target": { "name": "10.10.19.27", "id": "targetUUID", "type": "Device" } }, "overridable": true, "description": " ", "name": "device", "id": "deviceUUID", "metadata": { "timestamp": 1520419908146, "lastUser": { "name": "user1" }, "domain": { "name": "Global \\ INDIA \\ BENGALURU", "id": "domainUUID" } } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/urlgroups/{containerUUID}/overrides/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getUrlGroupOverride", "description": "**Retrieves all(Domain and Device) overrides on a URLGroup.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getUrlGroupOverride", "parameters": [ { "name": "objectId", "in": "path", "description": "Input NOT Expected here", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UrlGroupOverride" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/urlgroups/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getURLGroupObject", "description": "**Retrieves, deletes, creates, or modifies the url group objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all url group objects.**", "operationId": "getURLGroupObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "overrideTargetId", "in": "query", "description": "Retrieves the override(s) associated with the url group object on given target ID.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLGroupObject" }, "example": { "id": "UrlGroupUUID1", "name": "urlgroup_obj1", "type": "UrlGroup", "objects": [ { "type": "Url", "id": "UrlObjectUUID" } ], "literals": [ { "type": "Url", "url": "www.google.com" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateURLGroupObject", "description": "**Retrieves, deletes, creates, or modifies the url group objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all url group objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateURLGroupObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input url group object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLGroupObject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLGroupObject" }, "example": { "id": "UrlGroupUUID1", "name": "urlgroup_obj1_updated", "type": "UrlGroup", "objects": [ { "type": "Url", "id": "UrlObjectUUID" } ], "literals": [ { "type": "Url", "url": "www.google.com" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteURLGroupObject", "description": "**Retrieves, deletes, creates, or modifies the url group objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all url group objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteURLGroupObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLGroupObject" }, "example": { "id": "UrlGroupUUID2", "name": "urlgroup_obj2", "type": "UrlGroup", "objects": [ { "type": "Url", "id": "UrlObjectUUID" } ], "literals": [ { "type": "Url", "url": "www.google.com" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/urls": { "get": { "tags": [ "Object" ], "summary": "getAllURLObject", "description": "**Retrieves, deletes, creates, or modifies the url objects associated with the specified ID. If no ID is specified, retrieves list of all url objects.**", "operationId": "getAllURLObject", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLObjectListContainer" }, "example": { "links": { "self": "https://fmc_host_ip/api/fmc_config/v1/domain/subdomain_id/object/urls?offset=0&limit=1" }, "items": [ { "metadata": { "lastUser": { "name": "pvs" }, "domain": { "name": "Global \\ Asia", "id": "subdomain_id" } }, "links": { "self": "https://fmc_host_ip/api/fmc_config/v1/domain/subdomain_id/object/urls/urlObjectUUID" }, "type": "Url", "url": "www.cisco.com", "overridable": true, "overrides": { "parent": { "id": "urlObjectUUID", "type": "Url" }, "target": { "name": "Global \\ Asia", "id": "subdomain_id", "type": "Domain" } }, "description": " ", "name": "pvs_global_url", "id": "urlObjectUUID" } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createURLObject", "description": "**Retrieves, deletes, creates, or modifies the url objects associated with the specified ID. If no ID is specified, retrieves list of all url objects. _Check the response section for applicable examples (if any)._**", "operationId": "createURLObject", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for url objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input url object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLObject" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLObject" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/urls/{containerUUID}/overrides": { "get": { "tags": [ "Object" ], "summary": "getAllUrlOverride", "description": "**Retrieves all(Domain and Device) overrides on a URL object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getAllUrlOverride", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UrlOverrideListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/urls/urlUUID/overrides?offset=0&limit=1" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/urls/urlUUID?overrideTargetId=targetUUID" }, "type": "Url", "url": "abcDevice.com", "overrides": { "parent": { "id": "urlUUID", "type": "Url" }, "target": { "name": "10.10.19.27", "id": "targetUUID", "type": "Device" } }, "overridable": true, "description": " ", "name": "url_2", "id": "urlUUID", "metadata": { "timestamp": 1520419867090, "lastUser": { "name": "user1" }, "domain": { "name": "Global \\ INDIA \\ BENGALURU", "id": "domainUUID" } } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/urls/{containerUUID}/overrides/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getUrlOverride", "description": "**Retrieves all(Domain and Device) overrides on a URL object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getUrlOverride", "parameters": [ { "name": "objectId", "in": "path", "description": "Input NOT Expected here", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UrlOverride" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/urls/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getURLObject", "description": "**Retrieves, deletes, creates, or modifies the url objects associated with the specified ID. If no ID is specified, retrieves list of all url objects.**", "operationId": "getURLObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "overrideTargetId", "in": "query", "description": "Retrieves the override(s) associated with the url object on given target ID.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLObject" }, "example": { "metadata": { "lastUser": { "name": "pvs" }, "domain": { "name": "Global \\ Asia", "id": "subdomain_id" } }, "links": { "self": "https://fmc_host_ip/api/fmc_config/v1/domain/global/object/urls/urlObjectUUID" }, "type": "Url", "url": "www.cisco.com", "overridable": true, "overrides": { "parent": { "id": "urlObjectUUID", "type": "Url" }, "target": { "name": "Global \\ Asia", "id": "subdomain_id", "type": "Domain" } }, "description": " ", "name": "pvs_global_url", "id": "urlObjectUUID" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateURLObject", "description": "**Retrieves, deletes, creates, or modifies the url objects associated with the specified ID. If no ID is specified, retrieves list of all url objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateURLObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input url object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLObject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLObject" }, "example": { "type": "Url", "url": "www.cisco.com", "overridable": true, "overrides": { "parent": { "id": "url1_uuid", "type": "Url" }, "target": { "name": "10.10.16.29", "id": "target_uuid", "type": "Device" } }, "description": " ", "id": "url1_uuid", "name": "url1" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteURLObject", "description": "**Retrieves, deletes, creates, or modifies the url objects associated with the specified ID. If no ID is specified, retrieves list of all url objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteURLObject", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLObject" }, "example": { "metadata": { "lastUser": { "name": "admin" }, "domain": { "name": "Global", "id": "global_domain_id" } }, "links": { "self": "https://fmc_host_ip/api/fmc_config/v1/domain/global/object/urls/urlObjectUUID" }, "type": "Url", "url": "www.cisco.com", "overridable": false, "description": " ", "name": "url_obj1", "id": "urlObjectUUID" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/variablesets": { "get": { "tags": [ "Object" ], "summary": "getAllVariableSet", "description": "**Retrieves the variable set object associated with the specified ID. If no ID is specified, retrieves list of all variable set objects.**", "operationId": "getAllVariableSet", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableSetListContainer" }, "example": { "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/variablesets?offset=0&limit=2" }, "items": [ { "name": "Default-Set-TestDomain", "id": "Variable-Set-UUID-1", "type": "variableset", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/variablesets/Variable-Set-UUID-1" } }, { "name": "Default-Set", "id": "Variable-Set-UUID-2", "type": "variableset", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/variablesets/Variable-Set-UUID-2" } } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/variablesets/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getVariableSet", "description": "**Retrieves the variable set object associated with the specified ID. If no ID is specified, retrieves list of all variable set objects.**", "operationId": "getVariableSet", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the variable set object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableSet" }, "example": { "name": "Default-Set-TestDomain", "id": "Variable-Set-UUID-1", "type": "variableset", "description": "This Variable Set is system-provided.", "links": { "self": "https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/variablesets/Variable-Set-UUID-1" }, "metadata": { "readOnly": { "state": true }, "timestamp": 1460056664, "lastUser": { "name": "admin", "id": "User-UUID", "type": "user" }, "domain": { "name": "TestDomain", "id": "domainUUID", "type": "domain" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/vlangrouptags": { "get": { "tags": [ "Object" ], "summary": "getAllVlanTagGroup", "description": "**Retrieves, deletes, creates, or modifies the vlan group tag objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all vlan group tag objects.**", "operationId": "getAllVlanTagGroup", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTagGroupListContainer" }, "example": { "links": { "self": "/api/fmc_config/v1/domain/domain_uuid/object/vlangrouptags?offset=0&limit=1&overrideTargetId=target_uuid&expanded=true" }, "items": [ { "links": { "self": "/api/fmc_config/v1/domain/domain_uuid/object/vlangrouptags/vlangrp1_uuid?overrideTargetId=target_uuid" }, "objects": [ { "type": "VlanTag", "data": { "startTag": 10, "endTag": 20, "type": "VlanTagLiteral" }, "overridable": false, "id": "vlan1_uuid", "name": "vlan1" } ], "literals": [ { "startTag": 100, "endTag": 200, "type": "VlanTagLiteral" } ], "type": "VlanGroupTag", "overrides": { "parent": { "id": "vlangrp1_uuid", "type": "VlanGroupTag" }, "target": { "name": "10.10.16.29", "id": "target_uuid", "type": "Device" } }, "overridable": true, "description": " ", "id": "vlangrp1_uuid", "name": "vlangrp1", "metadata": { "timestamp": 1528267362103, "lastUser": { "name": "admin" }, "domain": { "name": "Global \\ ASIA \\ INDIA", "id": "domainUuid" } } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createVlanTagGroup", "description": "**Retrieves, deletes, creates, or modifies the vlan group tag objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all vlan group tag objects. _Check the response section for applicable examples (if any)._**", "operationId": "createVlanTagGroup", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for vlan group tags.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input vlan group tag object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTagGroup" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTagGroup" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/vlangrouptags/{containerUUID}/overrides": { "get": { "tags": [ "Object" ], "summary": "getAllVlanTagGroupOverride", "description": "**Retrieves all(Domain and Device) overrides on a VlanGroupTag Object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getAllVlanTagGroupOverride", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTagGroupOverrideListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/vlangrouptags/valnGroupTagUUID/overrides?offset=0&limit=1" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/vlangrouptags/valnGroupTagUUID?overrideTargetId=targetUUID" }, "type": "VlanGroupTag", "objects": [ { "type": "VlanTag", "data": { "startTag": 20, "endTag": 20, "type": "VlanTagLiteral" }, "overridable": false, "name": "Vlan_2", "id": "vlanObjectUUID" } ], "overrides": { "parent": { "id": "valnGroupTagUUID1", "type": "VlanGroupTag" }, "target": { "name": "10.10.19.27", "id": "targetUUID", "type": "Device" } }, "overridable": true, "description": " ", "name": "vlan_grp", "id": "valnGroupTagUUID1", "metadata": { "timestamp": 1520420232013, "lastUser": { "name": "user1" }, "domain": { "name": "Global \\ INDIA \\ BENGALURU", "id": "domainUUID" } } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/vlangrouptags/{containerUUID}/overrides/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getVlanTagGroupOverride", "description": "**Retrieves all(Domain and Device) overrides on a VlanGroupTag Object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getVlanTagGroupOverride", "parameters": [ { "name": "objectId", "in": "path", "description": "Input NOT Expected here", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTagGroupOverride" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/vlangrouptags/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getVlanTagGroup", "description": "**Retrieves, deletes, creates, or modifies the vlan group tag objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all vlan group tag objects.**", "operationId": "getVlanTagGroup", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "overrideTargetId", "in": "query", "description": "Retrieves the override(s) associated with the vlan group tag object on given target ID.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTagGroup" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateVlanTagGroup", "description": "**Retrieves, deletes, creates, or modifies the vlan group tag objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all vlan group tag objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateVlanTagGroup", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input vlan group tag object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTagGroup" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTagGroup" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteVlanTagGroup", "description": "**Retrieves, deletes, creates, or modifies the vlan group tag objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all vlan group tag objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteVlanTagGroup", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTagGroup" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/vlantags": { "get": { "tags": [ "Object" ], "summary": "getAllVlanTag", "description": "**Retrieves, deletes, creates, or modifies the vlantag objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all vlantag objects.**", "operationId": "getAllVlanTag", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTagListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/subDomainUUID/object/vlantags?offset=0&limit=1" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/subDomainUUID/object/vlantags/vlanObjectUUID" }, "data": { "startTag": 13, "endTag": 13, "type": "VlanTagLiteral" }, "type": "VlanTag", "overrides": { "parent": { "id": "vlanObjectUUID", "type": "VlanTag" }, "target": { "name": "Global \\ Asia", "id": "subDomainUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "pvs_vlan", "id": "vlanObjectUUID", "metadata": { "lastUser": { "name": "pvs" }, "domain": { "name": "Global \\ Asia", "id": "subDomainUUID" } } } ], "paging": { "offset": 0, "limit": 1, "count": 1, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "Object" ], "summary": "createVlanTag", "description": "**Retrieves, deletes, creates, or modifies the vlantag objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all vlantag objects. _Check the response section for applicable examples (if any)._**", "operationId": "createVlanTag", "parameters": [ { "name": "bulk", "in": "query", "description": "Enables bulk create for vlan tag objects.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input vlantag object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTag" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTag" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/vlantags/{containerUUID}/overrides": { "get": { "tags": [ "Object" ], "summary": "getAllVlanOverride", "description": "**Retrieves all(Domain and Device) overrides on a VlanTag Object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getAllVlanOverride", "parameters": [ { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanOverrideListContainer" }, "example": { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/vlantags/vlanTagUUID/overrides?offset=0&limit=2" }, "items": [ { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/vlantags/vlanTagUUID?overrideTargetId=targetUUID" }, "type": "VlanTag", "data": { "startTag": 13, "endTag": 13, "type": "VlanTagLiteral" }, "overrides": { "parent": { "id": "vlanTagUUID", "type": "VlanTag" }, "target": { "name": "Global \\ INDIA \\ BENGALURU", "id": "targetUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "vlan_1", "id": "vlanTagUUID", "metadata": { "timestamp": 1520419179300, "lastUser": { "name": "user1" }, "domain": { "name": "Global \\ INDIA \\ BENGALURU", "id": "targetUUID" } } }, { "links": { "self": "/fmc_config/v1/domain/domainUUID/object/vlantags/vlanTagUUID?overrideTargetId=targetUUID" }, "type": "VlanTag", "data": { "startTag": 14, "endTag": 14, "type": "VlanTagLiteral" }, "overrides": { "parent": { "id": "vlanTagUUID", "type": "VlanTag" }, "target": { "name": "Global \\ INDIA \\ PUNE", "id": "targetUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "vlan_1", "id": "vlanTagUUID", "metadata": { "timestamp": 1520419189983, "lastUser": { "name": "user1" }, "domain": { "name": "Global \\ INDIA \\ PUNE", "id": "targetUUID" } } } ], "paging": { "offset": 0, "limit": 2, "count": 2, "pages": 1 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/vlantags/{containerUUID}/overrides/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getVlanOverride", "description": "**Retrieves all(Domain and Device) overrides on a VlanTag Object.Response will always be in expanded form. If passed, the \"expanded\" query parameter will be ignored.**", "operationId": "getVlanOverride", "parameters": [ { "name": "objectId", "in": "path", "description": "Input NOT Expected here", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "containerUUID", "in": "path", "description": "The container id under which this specific resource is contained.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanOverride" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/object/vlantags/{objectId}": { "get": { "tags": [ "Object" ], "summary": "getVlanTag", "description": "**Retrieves, deletes, creates, or modifies the vlantag objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all vlantag objects.**", "operationId": "getVlanTag", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "overrideTargetId", "in": "query", "description": "Retrieves the override(s) associated with the vlantag object on given target ID.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTag" }, "example": { "links": { "self": "/fmc_config/v1/domain/global/object/vlantags/vlanObjectUUID" }, "data": { "startTag": 13, "endTag": 13, "type": "VlanTagLiteral" }, "type": "VlanTag", "overrides": { "parent": { "id": "vlanObjectUUID", "type": "VlanTag" }, "target": { "name": "Global \\ Asia", "id": "subDomainUUID", "type": "Domain" } }, "overridable": true, "description": " ", "name": "pvs_vlan", "id": "vlanObjectUUID", "metadata": { "lastUser": { "name": "pvs" }, "domain": { "name": "Global \\ Asia", "id": "subDomainUUID" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Object" ], "summary": "updateVlanTag", "description": "**Retrieves, deletes, creates, or modifies the vlantag objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all vlantag objects. _Check the response section for applicable examples (if any)._**", "operationId": "updateVlanTag", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The input vlantag object model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTag" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTag" }, "example": { "data": { "startTag": 10, "endTag": 20, "type": "VlanTagLiteral" }, "type": "VlanTag", "overridable": true, "overrides": { "parent": { "id": "vlan1_uuid", "type": "VlanTag" }, "target": { "name": "10.10.16.29", "id": "target_uuid", "type": "Device" } }, "description": " ", "id": "vlan1_uuid", "name": "vlan1" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false }, "delete": { "tags": [ "Object" ], "summary": "deleteVlanTag", "description": "**Retrieves, deletes, creates, or modifies the vlantag objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all vlantag objects. _Check the response section for applicable examples (if any)._**", "operationId": "deleteVlanTag", "parameters": [ { "name": "objectId", "in": "path", "description": "Unique identifier of the object.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanTag" }, "example": { "links": { "self": "/fmc_config/v1/domain/global/object/vlantags/vlanObject1UUID" }, "type": "VlanTag", "data": { "startTag": 1, "endTag": 3, "type": "VlanTagLiteral" }, "overridable": false, "description": " ", "name": "vlan_obj1", "id": "vlanObject1UUID", "metadata": { "lastUser": { "name": "admin" }, "domain": { "name": "Global", "id": "globalDomainUUID" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/deployment/deployabledevices": { "get": { "tags": [ "Deployment" ], "summary": "getDeployableDevice", "description": "**Retrieves list of all devices with configuration changes, ready to be deployed.**", "operationId": "getDeployableDevice", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index of first item to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Number of items to return.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expanded", "in": "query", "description": "If set to true, the GET response displays a list of objects with additional attributes.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeployableDeviceListContainer" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } }, "/api/fmc_config/v1/domain/{domainUUID}/deployment/deploymentrequests": { "post": { "tags": [ "Deployment" ], "summary": "createDeploymentRequest", "description": "**Creates a request for deploying configuration changes to devices. _Check the response section for applicable examples (if any)._**", "operationId": "createDeploymentRequest", "parameters": [ { "name": "domainUUID", "in": "path", "description": "Domain UUID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "JSON data for deploying to devices.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentRequest" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": false } } }, "components": { "schemas": { "ILinks": { "title": "ILinks", "type": "object", "properties": { "parent": { "type": "string", "description": "Full resource URL path to reference the parent (if any) for this resource." }, "self": { "type": "string", "description": "Full resource URL path to reference this particular resource." } }, "description": "This defines the self referencing links for the given resource." }, "AccessPolicyMetadata": { "title": "AccessPolicyMetadata", "type": "object", "properties": { "lastUser": { "$ref": "#/components/schemas/MetadataUser" }, "parentPolicy": { "$ref": "#/components/schemas/IReference" }, "inherit": { "type": "boolean" }, "domain": { "$ref": "#/components/schemas/Domain" }, "readOnly": { "$ref": "#/components/schemas/ReadOnly" }, "timestamp": { "type": "integer", "format": "int32" } } }, "PrefilterPolicy": { "title": "PrefilterPolicy", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IAdvertisement": { "title": "IAdvertisement", "type": "object", "properties": { "autoConfig": { "type": "boolean" }, "offlink": { "type": "boolean" }, "preferLifeTime": { "$ref": "#/components/schemas/PreferLifeTime" } } }, "VlanTagGroupOverrideListContainer": { "title": "VlanTagGroupOverrideListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VlanTagGroupOverride" }, "description": "" } } }, "PacketAnalyzerDevice": { "title": "PacketAnalyzerDevice", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "intValue": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "longValue": { "type": "integer", "format": "int32" }, "network": { "$ref": "#/components/schemas/NetworkObject" }, "password": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "cacert": { "type": "string" }, "name": { "type": "string" }, "host": { "type": "string" }, "insecure": { "type": "integer", "format": "int32" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "captureSession": { "type": "string" }, "username": { "type": "string" } } }, "NetworkOverrideListContainer": { "title": "NetworkOverrideListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkOverride" }, "description": "" } } }, "IVirtualSwitch": { "title": "IVirtualSwitch", "type": "object", "properties": { "dropBPDU": { "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "sensorPolicy": { "$ref": "#/components/schemas/IAccessPolicyModel" }, "description": { "type": "string" }, "type": { "type": "string" }, "strictTCPEnforcement": { "type": "boolean" }, "version": { "type": "string" }, "domainId": { "type": "integer", "format": "int32" }, "staticMacEntries": { "type": "array", "items": { "$ref": "#/components/schemas/IStaticMacEntry" }, "description": "" }, "name": { "type": "string" }, "switchedInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/IInterface" }, "description": "" }, "enableSpanningTreeProtocol": { "type": "boolean" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "hybridInterface": { "$ref": "#/components/schemas/IInterface" } } }, "FTDS2SVpnModelListContainer": { "title": "FTDS2SVpnModelListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FTDS2SVpnModel" }, "description": "" } } }, "InterfaceObject": { "title": "InterfaceObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/IFTDInterface" }, "description": "" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "ISourceZoneObject": { "title": "ISourceZoneObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IIPv4Container": { "title": "IIPv4Container", "type": "object", "properties": { "static": { "$ref": "#/components/schemas/IStaticIPContainer" }, "pppoe": { "$ref": "#/components/schemas/IPPPoEContianer" }, "dhcp": { "$ref": "#/components/schemas/IDHCPContainer" } } }, "IUrlBase": { "title": "IUrlBase", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "FilePolicyListContainer": { "title": "FilePolicyListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FilePolicy" }, "description": "" } } }, "SyslogConfigListContainer": { "title": "SyslogConfigListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SyslogConfig" }, "description": "" } } }, "RESTDiscoveryInfo": { "title": "RESTDiscoveryInfo", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "caCert": { "type": "string" }, "feedContent": { "type": "string" }, "description": { "type": "string" }, "invalidObservables": { "type": "integer", "format": "int32" }, "feedStatus": { "type": "string" }, "type": { "type": "string" }, "downloadOn": { "type": "boolean" }, "nextRun": { "type": "integer", "format": "int32" }, "consumedIndicators": { "type": "integer", "format": "int32" }, "totalObservables": { "type": "integer", "format": "int32" }, "totalIndicators": { "type": "integer", "format": "int32" }, "totalUnsupportedObservables": { "type": "integer", "format": "int32" }, "property": { "$ref": "#/components/schemas/RESTFeedProperty" }, "checksum": { "type": "string" }, "llfeedConfig": { "$ref": "#/components/schemas/LLFeedConfig" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "clientPrivateKey": { "type": "string" }, "subscribedCollections": { "type": "array", "items": { "$ref": "#/components/schemas/RESTCollectionTopic" }, "description": "" }, "delivery": { "type": "string" }, "clientCert": { "type": "string" }, "finishTime": { "type": "integer", "format": "int32" }, "availableCollections": { "type": "array", "items": { "$ref": "#/components/schemas/RESTCollectionTopic" }, "description": "" }, "lastRun": { "type": "integer", "format": "int32" }, "runNow": { "type": "boolean" }, "consumedObservables": { "type": "integer", "format": "int32" }, "totalDiscardedIndicators": { "type": "integer", "format": "int32" }, "refresh": { "type": "integer", "format": "int32" }, "params": { "$ref": "#/components/schemas/LLParams" }, "uri": { "type": "string" }, "feedConfig": { "$ref": "#/components/schemas/LLFeedConfig" }, "version": { "type": "string" }, "discoveryInfo": { "type": "array", "items": { "$ref": "#/components/schemas/RESTCollectionTopic" }, "description": "" }, "totalInvalidObservables": { "type": "integer", "format": "int32" }, "statusMsg": { "$ref": "#/components/schemas/LLStatusMsg" }, "passwd": { "type": "string" }, "startHour": { "type": "integer", "format": "int32" }, "consumedUnsupportedObservables": { "type": "integer", "format": "int32" }, "discardedIndicators": { "type": "integer", "format": "int32" }, "feedType": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" } } }, "AccessRule": { "title": "AccessRule", "required": [ "action" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/AccessRuleMetadata" }, "snmpConfig": { "$ref": "#/components/schemas/ISNMPConfig" }, "sourceNetworks": { "$ref": "#/components/schemas/INetworkObjectsContainer" }, "syslogSeverity": { "$ref": "#/components/schemas/SyslogSeverity1" }, "sourceZones": { "$ref": "#/components/schemas/ISourceZoneContainer" }, "destinationZones": { "$ref": "#/components/schemas/ISecurityZoneContainer" }, "description": { "type": "string", "description": "User provided resource description." }, "originalSourceNetworks": { "$ref": "#/components/schemas/INetworkObjectsContainer" }, "type": { "type": "string", "description": "Type of the access rule; this value is always AccessRule." }, "enableSyslog": { "type": "boolean", "description": "Boolean indicating whether the alerts associated with the access rule are sent to default syslog configuration in Access Control Logging." }, "safeSearch": { "$ref": "#/components/schemas/ISafeSearch" }, "enabled": { "type": "boolean", "description": "Boolean indicating whether the access rule is in effect (true) or not (false). Default is true." }, "syslogConfig": { "$ref": "#/components/schemas/ISyslogConfig" }, "urls": { "$ref": "#/components/schemas/IUrlObjectsContainer" }, "endPointDeviceTypes": { "type": "array", "items": { "$ref": "#/components/schemas/IEndPointDeviceType" }, "description": "Object representing the Endpoint Device Types (specified on the SGT/ISE Attributes tab of the Editing Rule dialog)." }, "destinationNetworks": { "$ref": "#/components/schemas/INetworkObjectsContainer" }, "youTube": { "$ref": "#/components/schemas/IYouTube" }, "action": { "$ref": "#/components/schemas/Action2" }, "links": { "$ref": "#/components/schemas/ILinks" }, "networkAccessDeviceIPs": { "$ref": "#/components/schemas/INetworkObjectsContainer" }, "id": { "type": "string", "description": "Unique identifier (UUID) for the access rule." }, "sourceSecurityGroupTags": { "$ref": "#/components/schemas/ISecurityGroupTagContainer" }, "logEnd": { "type": "boolean", "description": "Boolean indicating whether the device will log events at the end of the connection. Default is false." }, "logBegin": { "type": "boolean", "description": "Boolean indicating whether the device will log events at the beginning of the connection. Default is false." }, "sendEventsToFMC": { "type": "boolean", "description": "Boolean indicating whether the device will send events to the Firepower Management Center event viewer. Default is false." }, "destinationPorts": { "$ref": "#/components/schemas/IPortObjectsContainer" }, "sourcePorts": { "$ref": "#/components/schemas/IPortObjectsContainer" }, "ipsPolicy": { "$ref": "#/components/schemas/IIntrusionPolicyModel" }, "version": { "type": "string", "description": "Version number of the response object." }, "variableSet": { "$ref": "#/components/schemas/IVariableSet" }, "users": { "$ref": "#/components/schemas/IUsersContainer" }, "logFiles": { "type": "boolean", "description": "Boolean indicating whether the device will log file events. Default is false." }, "commentHistoryList": { "type": "array", "items": { "$ref": "#/components/schemas/ICommentHistory" }, "description": "List of comments in the access rule's comment history." }, "filePolicy": { "$ref": "#/components/schemas/IFilePolicy" }, "name": { "type": "string", "description": "User-specified name of the access rule." }, "vlanTags": { "$ref": "#/components/schemas/IVLanTagsContainer" }, "applications": { "$ref": "#/components/schemas/IApplicationsContainer" } }, "description": "Represents Access Rule contained within an Access Policy." }, "SecurityZoneObject": { "title": "SecurityZoneObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/IFTDInterface" }, "description": "Objects representing interfaces belonging to security zone." }, "interfaceMode": { "$ref": "#/components/schemas/InterfaceMode" }, "name": { "type": "string", "description": "User chosen resource name." }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "description": { "type": "string", "description": "User provided resource description." }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string", "description": "Unique identifier of response object." }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string", "description": "Type associated with resource: SecurityZone." }, "version": { "type": "string", "description": "Version number of the response object." } }, "description": "A model representing zone object definition." }, "VpnPKIEnrollmentModel": { "title": "VpnPKIEnrollmentModel", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IPatOptionsContainer": { "title": "IPatOptionsContainer", "type": "object", "properties": { "patPoolAddress": { "$ref": "#/components/schemas/INetworkAddress" }, "includeReserve": { "type": "boolean" }, "flatPortRange": { "type": "boolean" }, "interfacePat": { "type": "boolean" }, "extendedPat": { "type": "boolean" }, "roundRobin": { "type": "boolean" } } }, "IPolicyModel": { "title": "IPolicyModel", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "ApplicationProductivityListContainer": { "title": "ApplicationProductivityListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationProductivity" }, "description": "" } } }, "FTDHADeviceContainerListContainer": { "title": "FTDHADeviceContainerListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FTDHADeviceContainer" }, "description": "" } } }, "FPPhysicalInterface": { "title": "FPPhysicalInterface", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "description": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "enabled": { "type": "integer", "format": "int32" }, "mtu": { "type": "integer", "format": "int32" }, "mode": { "type": "string" }, "interfaceType": { "$ref": "#/components/schemas/InterfaceType" }, "mdi": { "type": "string" }, "name": { "type": "string" }, "staticArpEntries": { "type": "array", "items": { "$ref": "#/components/schemas/IStaticArpEntry" }, "description": "" }, "links": { "$ref": "#/components/schemas/Links" }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "" }, "id": { "type": "string" } } }, "NetworkGroupOverride": { "title": "NetworkGroupOverride", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Always returns false of overrides." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." } }, "description": "A model representing Network group override definition." }, "IPv6StaticRouteModelListContainer": { "title": "IPv6StaticRouteModelListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IPv6StaticRouteModel" }, "description": "" } } }, "DNSServerGroupObject": { "title": "DNSServerGroupObject", "type": "object", "properties": { "retries": { "type": "integer", "format": "int32" }, "defaultdomain": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "dnsservers": { "type": "array", "items": { "$ref": "#/components/schemas/INameServer" }, "description": "" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "timeout": { "type": "integer", "format": "int32" } } }, "FTDNatPolicyListContainer": { "title": "FTDNatPolicyListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FTDNatPolicy" }, "description": "" } } }, "IUrlCategoryAndReputation": { "title": "IUrlCategoryAndReputation", "type": "object", "properties": { "reputation": { "$ref": "#/components/schemas/Reputation" }, "type": { "type": "string" }, "category": { "$ref": "#/components/schemas/IURLCategory" } } }, "ICMPV6ObjectOverrideListContainer": { "title": "ICMPV6ObjectOverrideListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ICMPV6ObjectOverride" }, "description": "" } } }, "ApplicationFilter": { "title": "ApplicationFilter", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "appConditions": { "type": "array", "items": { "$ref": "#/components/schemas/IAppCondition" }, "description": "" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/IAppCondition" }, "description": "" }, "version": { "type": "string" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationModel" }, "description": "" } } }, "LLHashMap": { "title": "LLHashMap", "type": "object", "properties": { "additionalProperties": { "type": "string" } } }, "VlanTag": { "title": "VlanTag", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "data": { "$ref": "#/components/schemas/IVlanTagLiteral" }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "name": { "type": "string", "description": "User assigned resource name." }, "description": { "type": "string", "description": "User provided resource description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing response object." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." }, "overrideTargetId": { "type": "string", "description": "Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain)." } }, "description": "A model representing tag object definition." }, "RESTSettings": { "title": "RESTSettings", "type": "object", "properties": { "settings": { "$ref": "#/components/schemas/LLSettings" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IReference": { "title": "IReference", "type": "object", "properties": { "name": { "type": "string", "description": "User chosen resource name." }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Response object associated with resource." } }, "description": "Contains reference information." }, "FTDHADeviceContainer": { "title": "FTDHADeviceContainer", "required": [ "ftdHABootstrap", "secondary", "primary" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "modelId": { "type": "string", "description": "Model ID of the registered device (Example: A)." }, "description": { "type": "string", "description": "Retrieves or modifies the FTD HA record associated with the specified ID. Creates or breaks or deletes a FTD HA pair. If no ID is specified for a GET, retrieves list of all FTD HA pairs." }, "ftdHAFailoverTriggerCriteria": { "$ref": "#/components/schemas/IFTDHAFailoverInterfacePolicyTrigger" }, "modelType": { "type": "string", "description": "Model type of the registered device. (Example: Sensor)." }, "type": { "type": "string", "description": "DeviceHAPair." }, "version": { "type": "string", "description": "FTD HA model version." }, "ftdHABootstrap": { "$ref": "#/components/schemas/IFTDDeviceHABootStrap" }, "sw_version": { "type": "string", "description": "FTD HA device version." }, "secondary": { "$ref": "#/components/schemas/IBaseDevice" }, "healthStatus": { "type": "string", "description": "Indicates the health status." }, "healthPolicy": { "$ref": "#/components/schemas/IHealthPolicy" }, "name": { "type": "string", "description": "User-chosen name." }, "action": { "$ref": "#/components/schemas/Action3" }, "links": { "$ref": "#/components/schemas/ILinks" }, "model": { "type": "string", "description": "FTDHADeviceContainer." }, "modelNumber": { "type": "string", "description": "FTD HA Device model number." }, "forceBreak": { "type": "boolean", "description": "FTD HA Force Break option." }, "id": { "type": "string", "description": "FTD HA container UUID." }, "accessPolicy": { "$ref": "#/components/schemas/IPolicyModel" }, "primary": { "$ref": "#/components/schemas/IBaseDevice" } }, "description": "Input representation of FTD HA pair." }, "CountryObjectListContainer": { "title": "CountryObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CountryObject" }, "description": "" } } }, "ExternalLookupListContainer": { "title": "ExternalLookupListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalLookup" }, "description": "" } } }, "IUrlLiteral": { "title": "IUrlLiteral", "type": "object", "properties": { "type": { "type": "string" }, "url": { "type": "string" } } }, "FTDHAInterfaceMACAddressesListContainer": { "title": "FTDHAInterfaceMACAddressesListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FTDHAInterfaceMACAddresses" }, "description": "" } } }, "FTDAutoNatRuleListContainer": { "title": "FTDAutoNatRuleListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FTDAutoNatRule" }, "description": "" } } }, "ISubTask": { "title": "ISubTask", "type": "object", "properties": { "message": { "type": "string" }, "target": { "$ref": "#/components/schemas/ITarget" }, "status": { "type": "string" } } }, "UrlGroupOverrideListContainer": { "title": "UrlGroupOverrideListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UrlGroupOverride" }, "description": "" } } }, "TunnelTagsListContainer": { "title": "TunnelTagsListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TunnelTags" }, "description": "" } } }, "NetworkAddress": { "title": "NetworkAddress", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier of response object." }, "type": { "type": "string", "description": "Subtype of NetworkAddress (Host | Network | Range | NetworkGroup)." }, "value": { "type": "string", "description": "Actual value of child object." }, "version": { "type": "string", "description": "Version number of the response object." }, "overrideTargetId": { "type": "string", "description": "Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain)." } }, "description": "A model representing Network Address definition representing parent of Network sub types." }, "FTDHAInterfaceMACAddresses": { "title": "FTDHAInterfaceMACAddresses", "required": [ "failoverActiveMac", "failoverStandbyMac", "physicalInterface" ], "type": "object", "properties": { "failoverActiveMac": { "type": "string", "description": "Interface MAC address in H.H.H format, where H is a 16-bit hexadecimal digit. For example, the MAC address 00-0C-F1-42-4C-DE would be entered as 000C.F142.4CDE" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "failoverStandbyMac": { "type": "string", "description": "Standby MAC Address" }, "physicalInterface": { "$ref": "#/components/schemas/FTDBaseInterface" }, "name": { "type": "string", "description": "System chosen name" }, "description": { "type": "string", "description": "User provided resource description" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string", "description": "Identifier of a Firepower Threat Defense high availability failover interface MAC address" }, "type": { "type": "string", "description": "Type of the Firepower Threat Defense high availability failover interface MAC address" }, "version": { "type": "string", "description": "version" } }, "description": "Input Representation of Firepower Threat Defense high availability failover interface MAC addresses record associated with the specified FTD HA pair" }, "IInlinePair": { "title": "IInlinePair", "type": "object", "properties": { "first": { "$ref": "#/components/schemas/IInterface" }, "second": { "$ref": "#/components/schemas/IInterface" } } }, "ISafeSearch": { "title": "ISafeSearch", "type": "object", "properties": { "actionForNonSupportedEngines": { "$ref": "#/components/schemas/ActionForNonSupportedEngines" }, "enabled": { "type": "boolean" } } }, "VpnAdvancedSettingsListContainer": { "title": "VpnAdvancedSettingsListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VpnAdvancedSettings" }, "description": "" } } }, "IApplicationRisk": { "title": "IApplicationRisk", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IFTDDeviceHAFailoverLink": { "title": "IFTDDeviceHAFailoverLink", "required": [ "interfaceObject", "standbyIP", "activeIP", "logicalName" ], "type": "object", "properties": { "interfaceObject": { "$ref": "#/components/schemas/IFTDBaseInterface" }, "useIPv6Address": { "type": "boolean" }, "standbyIP": { "type": "string" }, "activeIP": { "type": "string" }, "logicalName": { "type": "string" }, "subnetMask": { "type": "string" } } }, "RESTFeedProperty": { "title": "RESTFeedProperty", "type": "object", "properties": { "llfeedProperty": { "$ref": "#/components/schemas/LLFeedProperty" }, "expirationTime": { "type": "integer", "format": "int32" }, "publish": { "type": "boolean" }, "action": { "type": "string" }, "whitelist": { "type": "boolean" }, "ttl": { "type": "integer", "format": "int32" }, "tags": { "$ref": "#/components/schemas/LLTags" } } }, "IFTDBaseInterface": { "title": "IFTDBaseInterface", "type": "object", "properties": { "enableAntiSpoofing": { "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "securityZone": { "$ref": "#/components/schemas/ISecurityZoneObjectModel" }, "activeMACAddress": { "type": "string" }, "fragmentReassembly": { "type": "boolean" }, "macTable": { "type": "array", "items": { "type": "string" }, "description": "" }, "standbyMACAddress": { "type": "string" }, "enableDNSLookup": { "type": "boolean" }, "description": { "type": "string" }, "overrideDefaultFragmentSetting": { "$ref": "#/components/schemas/IOverrideDefaultFragmentSetting" }, "type": { "type": "string" }, "version": { "type": "string" }, "enabled": { "type": "boolean" }, "MTU": { "type": "integer", "format": "int32" }, "mode": { "$ref": "#/components/schemas/Mode" }, "arpConfig": { "type": "array", "items": { "$ref": "#/components/schemas/IARPConfigContainer" }, "description": "" }, "ipv4": { "$ref": "#/components/schemas/IIPv4Container" }, "ifname": { "type": "string" }, "ipv6": { "$ref": "#/components/schemas/IIPv6Container" }, "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "macLearn": { "type": "boolean" }, "managementOnly": { "type": "boolean" } } }, "ICountryModel": { "title": "ICountryModel", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "iso2": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "iso3": { "type": "string" } } }, "FTDNatPolicy": { "title": "FTDNatPolicy", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "rules": { "type": "object" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IContinentModel": { "title": "IContinentModel", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "code": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/ICountryModel" }, "description": "" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "ErrorResponse": { "title": "ErrorResponse", "type": "object", "properties": { "severity": { "$ref": "#/components/schemas/Severity" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorMessagesContainer" }, "description": "" }, "category": { "$ref": "#/components/schemas/Category" } } }, "ProtocolPortObjectListContainer": { "title": "ProtocolPortObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolPortObject" }, "description": "" } } }, "IUrlObjectsContainer": { "title": "IUrlObjectsContainer", "type": "object", "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/IUrlBase" }, "description": "" }, "urlCategoriesWithReputation": { "type": "array", "items": { "$ref": "#/components/schemas/IUrlCategoryAndReputation" }, "description": "" }, "literals": { "type": "array", "items": { "$ref": "#/components/schemas/IUrlLiteral" }, "description": "" } } }, "INameServer": { "title": "INameServer", "type": "object", "properties": { "name-server": { "type": "string" } } }, "RESTIndicatorListContainer": { "title": "RESTIndicatorListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RESTIndicator" }, "description": "" } } }, "IApplicationProductivity": { "title": "IApplicationProductivity", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IVariableSet": { "title": "IVariableSet", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "RESTIndicator": { "title": "RESTIndicator", "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/LLIndicator" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "pending": { "type": "array", "items": { "type": "string" }, "description": "" }, "description": { "type": "string" }, "rawData": { "type": "string" }, "type": { "type": "string" }, "noRealizedIncidents": { "type": "integer", "format": "int32" }, "observables": { "type": "array", "items": { "$ref": "#/components/schemas/RESTObservable" }, "description": "" }, "feedId": { "type": "string" }, "effectiveProperty": { "$ref": "#/components/schemas/RESTFeedProperty" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "noPartialIncidents": { "type": "integer", "format": "int32" }, "customProperty": { "$ref": "#/components/schemas/RESTFeedProperty" }, "updatedAt": { "type": "integer", "format": "int32" }, "equation": { "$ref": "#/components/schemas/RESTIndicatorEquationNode" }, "containsUnsupported": { "type": "boolean" }, "version": { "type": "string" }, "iteratorId": { "type": "string" }, "indicatorVersion": { "type": "string" }, "containsInvalid": { "type": "boolean" }, "name": { "type": "string" }, "sourceName": { "type": "string" }, "inheritedProperty": { "$ref": "#/components/schemas/RESTFeedProperty" }, "fileId": { "type": "string" } } }, "FQDNOverrideListContainer": { "title": "FQDNOverrideListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FQDNOverride" }, "description": "" } } }, "CloudEventsListContainer": { "title": "CloudEventsListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CloudEvents" }, "description": "" } } }, "URLGroupObjectListContainer": { "title": "URLGroupObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/URLGroupObject" }, "description": "" } } }, "IDevice": { "title": "IDevice", "required": [ "hostName", "license_caps", "regKey" ], "type": "object", "properties": { "hostName": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "modelId": { "type": "string" }, "natID": { "type": "string" }, "license_caps": { "type": "array", "items": { "type": "string" }, "description": "" }, "description": { "type": "string" }, "ftdMode": { "$ref": "#/components/schemas/FtdMode" }, "modelType": { "type": "string" }, "regKey": { "type": "string" }, "keepLocalEvents": { "type": "boolean" }, "type": { "type": "string" }, "version": { "type": "string" }, "sw_version": { "type": "string" }, "healthStatus": { "type": "string" }, "healthPolicy": { "$ref": "#/components/schemas/IHealthPolicy" }, "name": { "type": "string" }, "model": { "type": "string" }, "modelNumber": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "accessPolicy": { "$ref": "#/components/schemas/IPolicyModel" }, "id": { "type": "string" }, "prohibitPacketTransfer": { "type": "boolean" }, "deviceGroup": { "$ref": "#/components/schemas/IDeviceGroup" } } }, "Upgrade": { "title": "Upgrade", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "pushUpgradeFileOnly": { "type": "boolean" }, "type": { "type": "string" }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/ITarget" }, "description": "" }, "version": { "type": "string" }, "upgradePackage": { "$ref": "#/components/schemas/UpgradePackage" } } }, "PrefilterHitCountListContainer": { "title": "PrefilterHitCountListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PrefilterHitCount" }, "description": "List of all hit count entries for given filter query on prefilter policy." } }, "description": "List of all hit count entries for given filter query on prefilter policy." }, "IInterfaceObjectModel": { "title": "IInterfaceObjectModel", "type": "object", "properties": { "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/IFTDInterface" }, "description": "" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IOverrideDefaultFragmentSetting": { "title": "IOverrideDefaultFragmentSetting", "type": "object", "properties": { "chain": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "timeout": { "type": "integer", "format": "int32" } } }, "IPortObject": { "title": "IPortObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IPolicyStatus": { "title": "IPolicyStatus", "type": "object", "properties": { "trafficInterrupting": { "type": "boolean" }, "upToDate": { "type": "boolean" }, "versionTimeStamp": { "type": "integer", "format": "int32" }, "referredPolicyList": { "type": "array", "items": { "$ref": "#/components/schemas/IPolicyStatus" }, "description": "" }, "policy": { "$ref": "#/components/schemas/IPolicyModel" } } }, "InterfaceGroupObjectListContainer": { "title": "InterfaceGroupObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/InterfaceGroupObject" }, "description": "" } } }, "IInterface": { "title": "IInterface", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "HostOverrideListContainer": { "title": "HostOverrideListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/HostOverride" }, "description": "" } } }, "Duration": { "title": "Duration", "type": "object", "properties": { "validLifeTime": { "type": "integer", "format": "int32" }, "preferLifeTime": { "type": "integer", "format": "int32" } } }, "RealmUserListContainer": { "title": "RealmUserListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RealmUser" }, "description": "" } } }, "IPFSSettings": { "title": "IPFSSettings", "type": "object", "properties": { "enabled": { "type": "boolean" }, "modulusGroup": { "type": "integer", "format": "int32" } } }, "IVpnIkev1Settings": { "title": "IVpnIkev1Settings", "type": "object", "properties": { "automaticPreSharedKeyLength": { "type": "integer", "format": "int32" }, "certificateAuth": { "$ref": "#/components/schemas/IReference" }, "authenticationType": { "$ref": "#/components/schemas/AuthenticationType" }, "manualPreSharedKey": { "type": "string", "description": "Contains the manual pre-shared key for the VPN, if any." }, "policy": { "$ref": "#/components/schemas/IReference" } }, "description": "Contains information about Internet Key Exchange version 1 settings for VPNs." }, "VlanOverride": { "title": "VlanOverride", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Always returns false for overrides." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." } }, "description": "A model representing vlan tag override definition." }, "IStaticArpEntry": { "title": "IStaticArpEntry", "type": "object", "properties": { "ip": { "type": "string" }, "mac": { "type": "string" } } }, "RESTCollectionTopic": { "title": "RESTCollectionTopic", "type": "object", "properties": { "collectionSubType": { "type": "string" }, "collectionAddress": { "type": "string" }, "collectionContentBinding": { "type": "string" }, "collectionPollIntervalInMinutes": { "type": "integer", "format": "int32" }, "collectionDescription": { "type": "string" }, "llcollectionTopic": { "$ref": "#/components/schemas/LLCollectionTopic" }, "type": { "type": "string" }, "collectionProtocolBinding": { "type": "string" }, "value": { "type": "string" }, "collectionMessageBinding": { "type": "string" }, "collectionName": { "type": "string" } } }, "PagingContainer": { "title": "PagingContainer", "type": "object", "properties": { "pages": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "ISecurityGroupTagLiteral": { "title": "ISecurityGroupTagLiteral", "type": "object", "properties": { "name": { "type": "string" }, "tag": { "type": "integer", "format": "int32" }, "type": { "type": "string" } } }, "SIURLFeedListContainer": { "title": "SIURLFeedListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SIURLFeed" }, "description": "" } } }, "FTDBridgeGroupInterfaceListContainer": { "title": "FTDBridgeGroupInterfaceListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FTDBridgeGroupInterface" }, "description": "" } } }, "IHardwareContainer": { "title": "IHardwareContainer", "type": "object", "properties": { "duplex": { "$ref": "#/components/schemas/Duplex" }, "speed": { "$ref": "#/components/schemas/Speed" } } }, "IS2SIkeAdvanceSettingModel": { "title": "IS2SIkeAdvanceSettingModel", "type": "object", "properties": { "peerIdentityValidation": { "$ref": "#/components/schemas/PeerIdentityValidation" }, "enableNotificationOnTunnelDisconnect": { "type": "boolean" }, "thresholdToChallengeIncomingCookies": { "type": "integer", "format": "int32" }, "ikeKeepaliveSettings": { "$ref": "#/components/schemas/IIkeKeepaliveSettings" }, "identitySentToPeer": { "$ref": "#/components/schemas/IdentitySentToPeer" }, "enableAggressiveMode": { "type": "boolean" }, "cookieChallenge": { "$ref": "#/components/schemas/CookieChallenge" }, "maximumNumberOfSAsAllowed": { "type": "integer", "format": "int32" }, "percentageOfSAsAllowedInNegotiation": { "type": "integer", "format": "int32" } } }, "PacketAnalyzerDeviceListContainer": { "title": "PacketAnalyzerDeviceListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PacketAnalyzerDevice" }, "description": "" } } }, "LLObservation": { "title": "LLObservation", "type": "object", "properties": { "elementId": { "type": "string" }, "data": { "$ref": "#/components/schemas/LLObservationData" }, "count": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "version": { "type": "string" }, "elementName": { "type": "string" }, "timestamp": { "type": "integer", "format": "int32" } } }, "VpnAdvancedSettings": { "title": "VpnAdvancedSettings", "type": "object", "properties": { "advancedIkeSetting": { "$ref": "#/components/schemas/IS2SIkeAdvanceSettingModel" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "advancedTunnelSetting": { "$ref": "#/components/schemas/IS2STunnelAdvanceSettingModel" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "advancedIpsecSetting": { "$ref": "#/components/schemas/IS2SIpSecAdvanceSettingModel" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "PortObject": { "title": "PortObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/PortMetadata" }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." }, "overrideTargetId": { "type": "string", "description": "Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain)." } }, "description": "A model representing port object definition." }, "RealmListContainer": { "title": "RealmListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Realm" }, "description": "" } } }, "IS2SIpSecAdvanceSettingModel": { "title": "IS2SIpSecAdvanceSettingModel", "type": "object", "properties": { "enableFragmentationBeforeEncryption": { "type": "boolean", "description": "Indicates whether to enable transmission unit fragmentation before encryption." }, "maximumTransmissionUnitAging": { "$ref": "#/components/schemas/IMaximumTransmissionUnitAging" } }, "description": "Contains site-to-site IPSec advanced settings." }, "RealmUserGroup": { "title": "RealmUserGroup", "type": "object", "properties": { "name": { "type": "string" }, "realmUuid": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "realm": { "$ref": "#/components/schemas/IRealm" }, "id": { "type": "string" }, "type": { "type": "string" } } }, "IFPPhysicalInterface": { "title": "IFPPhysicalInterface", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "description": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "enabled": { "type": "integer", "format": "int32" }, "mtu": { "type": "integer", "format": "int32" }, "mode": { "type": "string" }, "interfaceType": { "$ref": "#/components/schemas/InterfaceType" }, "mdi": { "type": "string" }, "staticArpEntries": { "type": "array", "items": { "$ref": "#/components/schemas/IStaticArpEntry" }, "description": "" }, "name": { "type": "string" }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" } } }, "IFilePolicy": { "title": "IFilePolicy", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "URLObject": { "title": "URLObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier of response object." }, "type": { "type": "string", "description": "Type associated with resource: URL." }, "version": { "type": "string", "description": "Version number of the response object." }, "url": { "type": "string", "description": "Actual URL of object." }, "overrideTargetId": { "type": "string", "description": "Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain)." } }, "description": "A model representing url object definition." }, "AccessPolicyLoggingSettingModel": { "title": "AccessPolicyLoggingSettingModel", "type": "object", "properties": { "fileAndMalwareSyslogConfig": { "$ref": "#/components/schemas/ISyslogConfig" }, "syslogConfigFromPlatformSetting": { "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "description": { "type": "string" }, "enableFileAndMalwareSyslog": { "type": "boolean" }, "type": { "type": "string" }, "version": { "type": "string" }, "syslogConfig": { "$ref": "#/components/schemas/ISyslogConfig" }, "name": { "type": "string" }, "fileAndMalwareSyslogSeverity": { "$ref": "#/components/schemas/FileAndMalwareSyslogSeverity" }, "severityForPlatformSettingSyslogConfig": { "$ref": "#/components/schemas/SeverityForPlatformSettingSyslogConfig" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" } } }, "GeoLocationObject": { "title": "GeoLocationObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "description": { "type": "string" }, "continentUUID": { "type": "string" }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/ICountryModel" }, "description": "" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" }, "continents": { "type": "array", "items": { "$ref": "#/components/schemas/IContinentModel" }, "description": "" }, "continentId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" } } }, "FTDManualNatRule": { "title": "FTDManualNatRule", "required": [ "natType", "originalSource" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "translatedDestinationPort": { "$ref": "#/components/schemas/IProtocolPortObject" }, "fallThrough": { "type": "boolean" }, "natType": { "$ref": "#/components/schemas/NatType" }, "targetIndex": { "type": "integer", "format": "int32" }, "translatedSourcePort": { "$ref": "#/components/schemas/IProtocolPortObject" }, "translatedDestination": { "$ref": "#/components/schemas/INetworkAddress" }, "description": { "type": "string" }, "section": { "type": "string" }, "type": { "type": "string" }, "enabled": { "type": "boolean" }, "originalSourcePort": { "$ref": "#/components/schemas/IProtocolPortObject" }, "sourceInterface": { "$ref": "#/components/schemas/IInterfaceObjectModel" }, "interfaceInOriginalDestination": { "type": "boolean" }, "netToNet": { "type": "boolean" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "originalSource": { "$ref": "#/components/schemas/INetworkAddress" }, "dns": { "type": "boolean" }, "patOptions": { "$ref": "#/components/schemas/IPatOptionsContainer" }, "version": { "type": "string" }, "noProxyArp": { "type": "boolean" }, "translatedSource": { "$ref": "#/components/schemas/INetworkAddress" }, "interfaceInTranslatedSource": { "type": "boolean" }, "routeLookup": { "type": "boolean" }, "originalDestination": { "$ref": "#/components/schemas/INetworkAddress" }, "unidirectional": { "type": "boolean" }, "name": { "type": "string" }, "destinationInterface": { "$ref": "#/components/schemas/IInterfaceObjectModel" }, "originalDestinationPort": { "$ref": "#/components/schemas/IProtocolPortObject" }, "interfaceIpv6": { "type": "boolean" } } }, "IS2STunnelAdvanceSettingModel": { "title": "IS2STunnelAdvanceSettingModel", "type": "object", "properties": { "natKeepaliveMessageTraversal": { "$ref": "#/components/schemas/INatKeepaliveTraversal" }, "enableSpokeToSpokeConnectivityThroughHub": { "type": "boolean", "description": "Indicates whether spoke-to-spoke connectivity is enabled through the hub." }, "certificateMapSettings": { "$ref": "#/components/schemas/ICertificateMapSettings" }, "bypassAccessControlTrafficForDecryptedTraffic": { "type": "boolean", "description": "Indicates whether to bypass access control for decrypted traffic." } }, "description": "Contains advanced site-to-site tunnel settings." }, "Ikev1PolicyObject": { "title": "Ikev1PolicyObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "description": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "version": { "type": "string" }, "encryption": { "type": "string" }, "diffieHellmanGroup": { "type": "integer", "format": "int32" }, "authenticationMethod": { "type": "string" }, "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "lifetimeInSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" }, "hash": { "type": "string" } } }, "Ikev2PolicyObject": { "title": "Ikev2PolicyObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "encryptionAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "" }, "description": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "diffieHellmanGroups": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "" }, "version": { "type": "string" }, "prfIntegrityAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "" }, "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "lifetimeInSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" }, "integrityAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "RESTElementListContainer": { "title": "RESTElementListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RESTElement" }, "description": "" } } }, "NetworkGroupListContainer": { "title": "NetworkGroupListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkGroup" }, "description": "" } } }, "IMaximumTransmissionUnitAging": { "title": "IMaximumTransmissionUnitAging", "type": "object", "properties": { "resetIntervalMinutes": { "type": "integer", "description": "Interval before resetting the MTU.", "format": "int32" }, "enabled": { "type": "boolean", "description": "Indicates whether MTU aging is enabled." } }, "description": "Contains information about Maximum Transmission UNit aging." }, "VirtualSwitchListContainer": { "title": "VirtualSwitchListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualSwitch" }, "description": "" } } }, "IApplicationFilter": { "title": "IApplicationFilter", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/IAppCondition" }, "description": "" }, "type": { "type": "string" }, "version": { "type": "string" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationModel" }, "description": "" } } }, "FPInterfaceStatistics": { "title": "FPInterfaceStatistics", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "rxBytes": { "type": "integer", "format": "int32" }, "txBytes": { "type": "integer", "format": "int32" }, "interfaceUuid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "droppedPackets": { "type": "integer", "format": "int32" } } }, "ICMPV4ObjectOverrideListContainer": { "title": "ICMPV4ObjectOverrideListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ICMPV4ObjectOverride" }, "description": "" } } }, "FTDSubInterface": { "title": "FTDSubInterface", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "description": { "type": "string" }, "type": { "type": "string" }, "enabled": { "type": "boolean" }, "MTU": { "type": "integer", "format": "int32" }, "mode": { "$ref": "#/components/schemas/Mode" }, "subIntfId": { "type": "integer", "format": "int32" }, "arpConfig": { "type": "array", "items": { "$ref": "#/components/schemas/IARPConfigContainer" }, "description": "" }, "ipv4": { "$ref": "#/components/schemas/IIPv4Container" }, "ifname": { "type": "string" }, "ipv6": { "$ref": "#/components/schemas/IIPv6Container" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "macLearn": { "type": "boolean" }, "managementOnly": { "type": "boolean" }, "enableAntiSpoofing": { "type": "boolean" }, "securityZone": { "$ref": "#/components/schemas/ISecurityZoneObjectModel" }, "activeMACAddress": { "type": "string" }, "vlanId": { "type": "integer", "format": "int32" }, "fragmentReassembly": { "type": "boolean" }, "macTable": { "type": "array", "items": { "type": "string" }, "description": "" }, "standbyMACAddress": { "type": "string" }, "enableDNSLookup": { "type": "boolean" }, "overrideDefaultFragmentSetting": { "$ref": "#/components/schemas/IOverrideDefaultFragmentSetting" }, "version": { "type": "string" }, "name": { "type": "string" } } }, "SecurityGroupTagListContainer": { "title": "SecurityGroupTagListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityGroupTag" }, "description": "" } } }, "ExpirationLifeTime": { "title": "ExpirationLifeTime", "type": "object", "properties": { "preferDateTime": { "type": "string" }, "validDateTime": { "type": "string" } } }, "IAppCondition": { "title": "IAppCondition", "type": "object", "properties": { "search": { "type": "string" }, "risks": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationRisk" }, "description": "" }, "productivities": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationProductivity" }, "description": "" }, "applicationTypes": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationType" }, "description": "" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationCategory" }, "description": "" }, "type": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationTag" }, "description": "" } } }, "FilePolicy": { "title": "FilePolicy", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "HostOverride": { "title": "HostOverride", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Always return false for overrides." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." } }, "description": "A model representing Host network override definition." }, "StaticRouteModel": { "title": "StaticRouteModel", "required": [ "selectedNetworks", "metricValue", "interfaceName", "gateway" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "selectedNetworks": { "type": "array", "items": { "$ref": "#/components/schemas/INetworkAddress" }, "description": "" }, "metricValue": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "isTunneled": { "type": "boolean" }, "interfaceName": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "gateway": { "$ref": "#/components/schemas/IHostObjectContainer" } } }, "FTDNatRule": { "title": "FTDNatRule", "required": [ "natType" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "fallThrough": { "type": "boolean" }, "natType": { "$ref": "#/components/schemas/NatType" }, "dns": { "type": "boolean" }, "description": { "type": "string" }, "section": { "type": "string" }, "patOptions": { "$ref": "#/components/schemas/IPatOptionsContainer" }, "type": { "type": "string" }, "version": { "type": "string" }, "noProxyArp": { "type": "boolean" }, "sourceInterface": { "$ref": "#/components/schemas/IInterfaceObjectModel" }, "routeLookup": { "type": "boolean" }, "name": { "type": "string" }, "netToNet": { "type": "boolean" }, "links": { "$ref": "#/components/schemas/ILinks" }, "destinationInterface": { "$ref": "#/components/schemas/IInterfaceObjectModel" }, "id": { "type": "string" }, "interfaceIpv6": { "type": "boolean" } } }, "LLEquationNode": { "title": "LLEquationNode", "type": "object", "properties": { "op": { "type": "string" }, "condition": { "type": "string" }, "isRealized": { "type": "boolean" }, "children": { "type": "array", "items": { "type": "object" }, "description": "" }, "type": { "type": "string" }, "value": { "type": "string" }, "applyCondition": { "type": "string" } } }, "LLStatusMsg": { "title": "LLStatusMsg", "type": "object", "properties": { "additionalProperties": { "$ref": "#/components/schemas/LLAdditionalProperties" } } }, "RESTObservation": { "title": "RESTObservation", "type": "object", "properties": { "elementId": { "type": "string" }, "data": { "$ref": "#/components/schemas/RESTObservationData" }, "count": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "timestamp": { "type": "integer", "format": "int32" }, "elementName": { "type": "string" }, "llobservation": { "$ref": "#/components/schemas/LLObservation" } } }, "IKEv1IPsecProposalListContainer": { "title": "IKEv1IPsecProposalListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IKEv1IPsecProposal" }, "description": "" } } }, "VariableSetListContainer": { "title": "VariableSetListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VariableSet" }, "description": "" } } }, "Application": { "title": "Application", "type": "object", "properties": { "applicationTags": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationTag" }, "description": "" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "appProductivity": { "$ref": "#/components/schemas/ApplicationProductivity" }, "deprecated": { "type": "boolean" }, "description": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "decrypted": { "type": "boolean" }, "version": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationTag" }, "description": "" }, "productivity": { "$ref": "#/components/schemas/IApplicationProductivity" }, "appId": { "type": "integer", "format": "int32" }, "appCategories": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationCategory" }, "description": "" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "links": { "$ref": "#/components/schemas/ILinks" }, "risk": { "$ref": "#/components/schemas/IApplicationRisk" }, "applicationTypes": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationType" }, "description": "" }, "id": { "type": "string" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationCategory" }, "description": "" } } }, "ExternalLookup": { "title": "ExternalLookup", "type": "object", "properties": { "template": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "intValue": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "longValue": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "network": { "$ref": "#/components/schemas/NetworkObject" } } }, "PrefilterHitCount": { "title": "PrefilterHitCount", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/HitCountMetadata" }, "lastFetchTimeStamp": { "type": "string", "description": "Indicates the last time (in ISO 8601 format) the hit count was retrieved for the mentioned rule." }, "hitCount": { "type": "integer", "description": "Indicates the number of times the prefilter rule was hit on the target device. It is based on the data from the last FMC hit count refresh operation.", "format": "int32" }, "firstHitTimeStamp": { "type": "string", "description": "Indicates the time (in ISO 8601 format) when the hit count was first hit for the mentioned rule." }, "rule": { "$ref": "#/components/schemas/IPolicyModel" }, "lastHitTimeStamp": { "type": "string", "description": "Indicates the time (in ISO 8601 format) when the hit count was last hit for the mentioned rule." }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "type": { "type": "string", "description": "Type must be PrefilterHitCount." }, "version": { "type": "string" } }, "description": "Model of HitCount entry for a prefilter rule." }, "ServerVersion": { "title": "ServerVersion", "type": "object", "properties": { "serverVersion": { "type": "string" }, "vdbVersion": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "geoVersion": { "type": "string" }, "id": { "type": "string" }, "sruVersion": { "type": "string" }, "type": { "type": "string" } } }, "ServerVersionListContainer": { "title": "ServerVersionListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ServerVersion" }, "description": "" } } }, "FTDHAMonitoredInterfacesListContainer": { "title": "FTDHAMonitoredInterfacesListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FTDHAMonitoredInterfaces" }, "description": "" } } }, "LLObservable": { "title": "LLObservable", "type": "object", "properties": { "miscData": { "$ref": "#/components/schemas/LLMiscData" }, "type": { "type": "string" }, "observableType": { "type": "string" }, "version": { "type": "string" }, "unEncryptedDBId": { "type": "string" }, "indicatorCount": { "type": "integer", "format": "int32" }, "effectiveProperty": { "$ref": "#/components/schemas/LLFeedProperty" }, "dbid": { "type": "string" }, "id": { "type": "string" }, "value": { "type": "string" }, "inheritedProperty": { "$ref": "#/components/schemas/LLFeedProperty" }, "customProperty": { "$ref": "#/components/schemas/LLFeedProperty" }, "updatedAt": { "type": "integer", "format": "int32" } } }, "FTDRedundantInterface": { "title": "FTDRedundantInterface", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "description": { "type": "string" }, "type": { "type": "string" }, "enabled": { "type": "boolean" }, "MTU": { "type": "integer", "format": "int32" }, "mode": { "$ref": "#/components/schemas/Mode" }, "arpConfig": { "type": "array", "items": { "$ref": "#/components/schemas/IARPConfigContainer" }, "description": "" }, "ipv4": { "$ref": "#/components/schemas/IIPv4Container" }, "ifname": { "type": "string" }, "ipv6": { "$ref": "#/components/schemas/IIPv6Container" }, "links": { "$ref": "#/components/schemas/ILinks" }, "primaryInterface": { "$ref": "#/components/schemas/IInterface" }, "id": { "type": "string" }, "macLearn": { "type": "boolean" }, "managementOnly": { "type": "boolean" }, "enableAntiSpoofing": { "type": "boolean" }, "securityZone": { "$ref": "#/components/schemas/ISecurityZoneObjectModel" }, "activeMACAddress": { "type": "string" }, "fragmentReassembly": { "type": "boolean" }, "macTable": { "type": "array", "items": { "type": "string" }, "description": "" }, "standbyMACAddress": { "type": "string" }, "enableDNSLookup": { "type": "boolean" }, "overrideDefaultFragmentSetting": { "$ref": "#/components/schemas/IOverrideDefaultFragmentSetting" }, "version": { "type": "string" }, "name": { "type": "string" }, "redundantId": { "type": "integer", "format": "int32" }, "secondaryInterface": { "$ref": "#/components/schemas/IInterface" } } }, "LLMiscData": { "title": "LLMiscData", "type": "object", "properties": { "additionalProperties": { "type": "string" } } }, "IBaseDevice": { "title": "IBaseDevice", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "modelId": { "type": "string" }, "description": { "type": "string" }, "modelType": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "sw_version": { "type": "string" }, "healthStatus": { "type": "string" }, "healthPolicy": { "$ref": "#/components/schemas/IHealthPolicy" }, "name": { "type": "string" }, "model": { "type": "string" }, "modelNumber": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "accessPolicy": { "$ref": "#/components/schemas/IPolicyModel" }, "id": { "type": "string" } } }, "FTDPhysicalInterfaceListContainer": { "title": "FTDPhysicalInterfaceListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FTDPhysicalInterface" }, "description": "" } } }, "ApplicationRiskListContainer": { "title": "ApplicationRiskListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationRisk" }, "description": "" } } }, "SLAMonitorObjectModel": { "title": "SLAMonitorObjectModel", "required": [ "slaId", "interfaceObjects", "monitorAddress" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "noOfPackets": { "type": "integer", "format": "int32" }, "slaId": { "type": "integer", "format": "int32" }, "dataSize": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "threshold": { "type": "integer", "format": "int32" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "interfaceNames": { "type": "array", "items": { "type": "string" }, "description": "" }, "type": { "type": "string" }, "version": { "type": "string" }, "timeout": { "type": "integer", "format": "int32" }, "interfaceObjects": { "type": "array", "items": { "$ref": "#/components/schemas/IInterfaceObjectModel" }, "description": "" }, "frequency": { "type": "integer", "format": "int32" }, "monitorAddress": { "type": "string" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "tos": { "type": "integer", "format": "int32" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" } } }, "IStaticIPContainer": { "title": "IStaticIPContainer", "type": "object", "properties": { "address": { "type": "string" }, "netmask": { "type": "string" } } }, "INatKeepaliveTraversal": { "title": "INatKeepaliveTraversal", "type": "object", "properties": { "enabled": { "type": "boolean" }, "intervalSeconds": { "type": "integer", "format": "int32" } } }, "LLIncident": { "title": "LLIncident", "type": "object", "properties": { "indicatorName": { "type": "string" }, "equation": { "$ref": "#/components/schemas/LLEquationNode" }, "description": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "indicatorId": { "type": "string" }, "actionTaken": { "type": "string" }, "feedId": { "type": "string" }, "observations": { "type": "array", "items": { "$ref": "#/components/schemas/LLObservation" }, "description": "" }, "publish": { "type": "boolean" }, "name": { "type": "string" }, "property": { "$ref": "#/components/schemas/LLFeedProperty" }, "id": { "type": "string" }, "sourceName": { "type": "string" }, "realizedAt": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "updatedAt": { "type": "integer", "format": "int32" } } }, "ISESecurityGroupTagListContainer": { "title": "ISESecurityGroupTagListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ISESecurityGroupTag" }, "description": "" } } }, "IMetadataUser": { "title": "IMetadataUser", "type": "object", "properties": { "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" } } }, "IIkeKeepaliveSettings": { "title": "IIkeKeepaliveSettings", "type": "object", "properties": { "threshold": { "type": "integer", "format": "int32" }, "retryInterval": { "type": "integer", "format": "int32" }, "ikeKeepalive": { "$ref": "#/components/schemas/IkeKeepalive" } } }, "SIURLList": { "title": "SIURLList", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "UpgradePackage": { "title": "UpgradePackage", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" } } }, "FTDEtherChannelInterfaceListContainer": { "title": "FTDEtherChannelInterfaceListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FTDEtherChannelInterface" }, "description": "" } } }, "TaskStatus": { "title": "TaskStatus", "type": "object", "properties": { "taskType": { "$ref": "#/components/schemas/TaskType" }, "subTasks": { "type": "array", "items": { "$ref": "#/components/schemas/ISubTask" }, "description": "" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } } }, "ICertificateMapSettings": { "title": "ICertificateMapSettings", "type": "object", "properties": { "useCertMapConfiguredInEndpointToDetermineTunnel": { "type": "boolean" }, "usePeerIpAddressToDetermineTunnel": { "type": "boolean" }, "useCertificateOuToDetermineTunnel": { "type": "boolean" }, "useIkeIdentityOuToDetermineTunnel": { "type": "boolean" } } }, "ProtocolPortObjectOverrideListContainer": { "title": "ProtocolPortObjectOverrideListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolPortObjectOverride" }, "description": "" } } }, "RESTTaxiiCollection": { "title": "RESTTaxiiCollection", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "caCert": { "type": "string" }, "feedContent": { "type": "string" }, "description": { "type": "string" }, "invalidObservables": { "type": "integer", "format": "int32" }, "feedStatus": { "type": "string" }, "type": { "type": "string" }, "downloadOn": { "type": "boolean" }, "nextRun": { "type": "integer", "format": "int32" }, "consumedIndicators": { "type": "integer", "format": "int32" }, "totalObservables": { "type": "integer", "format": "int32" }, "totalIndicators": { "type": "integer", "format": "int32" }, "totalUnsupportedObservables": { "type": "integer", "format": "int32" }, "property": { "$ref": "#/components/schemas/RESTFeedProperty" }, "checksum": { "type": "string" }, "llfeedConfig": { "$ref": "#/components/schemas/LLFeedConfig" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "clientPrivateKey": { "type": "string" }, "subscribedCollections": { "type": "array", "items": { "$ref": "#/components/schemas/RESTCollectionTopic" }, "description": "" }, "delivery": { "type": "string" }, "clientCert": { "type": "string" }, "finishTime": { "type": "integer", "format": "int32" }, "availableCollections": { "type": "array", "items": { "$ref": "#/components/schemas/RESTCollectionTopic" }, "description": "" }, "lastRun": { "type": "integer", "format": "int32" }, "runNow": { "type": "boolean" }, "consumedObservables": { "type": "integer", "format": "int32" }, "totalDiscardedIndicators": { "type": "integer", "format": "int32" }, "refresh": { "type": "integer", "format": "int32" }, "params": { "$ref": "#/components/schemas/LLParams" }, "uri": { "type": "string" }, "feedConfig": { "$ref": "#/components/schemas/LLFeedConfig" }, "version": { "type": "string" }, "discoveryInfo": { "type": "array", "items": { "$ref": "#/components/schemas/RESTCollectionTopic" }, "description": "" }, "totalInvalidObservables": { "type": "integer", "format": "int32" }, "statusMsg": { "$ref": "#/components/schemas/LLStatusMsg" }, "passwd": { "type": "string" }, "startHour": { "type": "integer", "format": "int32" }, "consumedUnsupportedObservables": { "type": "integer", "format": "int32" }, "discardedIndicators": { "type": "integer", "format": "int32" }, "feedType": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" } } }, "IntrusionPolicyListContainer": { "title": "IntrusionPolicyListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IntrusionPolicy" }, "description": "" } } }, "PortObjectListContainer": { "title": "PortObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PortObject" }, "description": "" } } }, "ApplicationProductivity": { "title": "ApplicationProductivity", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "ProtocolPortObjectOverride": { "title": "ProtocolPortObjectOverride", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Always returns false for overrides." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." } }, "description": "A model representing protocol port object override definition." }, "IKEv1IPsecProposal": { "title": "IKEv1IPsecProposal", "type": "object", "properties": { "espEncryption": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "espHash": { "type": "string" } } }, "VpnIPSecSettings": { "title": "VpnIPSecSettings", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "ikeV1IpsecProposal": { "type": "array", "items": { "$ref": "#/components/schemas/IReference" }, "description": "" }, "perfectForwardSecrecy": { "$ref": "#/components/schemas/IPFSSettings" }, "lifetimeSeconds": { "type": "integer", "format": "int32" }, "ikeV2IpsecProposal": { "type": "array", "items": { "$ref": "#/components/schemas/IReference" }, "description": "" }, "tfcPackets": { "$ref": "#/components/schemas/ITFCPackets" }, "ikeV2Mode": { "$ref": "#/components/schemas/IkeV2Mode" }, "description": { "type": "string" }, "cryptoMapType": { "$ref": "#/components/schemas/CryptoMapType" }, "enableSaStrengthEnforcement": { "type": "boolean" }, "type": { "type": "string" }, "version": { "type": "string" }, "lifetimeKilobytes": { "type": "integer", "format": "int32" }, "validateIncomingIcmpErrorMessage": { "type": "boolean" }, "doNotFragmentPolicy": { "$ref": "#/components/schemas/DoNotFragmentPolicy" }, "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "enableRRI": { "type": "boolean" } } }, "IVlanTagLiteral": { "title": "IVlanTagLiteral", "type": "object", "properties": { "startTag": { "type": "integer", "format": "int32" }, "endTag": { "type": "integer", "format": "int32" }, "type": { "type": "string" } } }, "IApplicationCategory": { "title": "IApplicationCategory", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IDomain": { "title": "IDomain", "type": "object", "properties": { "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" } } }, "IRealmEntity": { "title": "IRealmEntity", "type": "object", "properties": { "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" } } }, "IPortObjectsContainer": { "title": "IPortObjectsContainer", "type": "object", "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/IPortObject" }, "description": "" }, "literals": { "type": "array", "items": { "$ref": "#/components/schemas/IBasePortLiteral" }, "description": "" } } }, "IAccessPolicyDefaultAction": { "title": "IAccessPolicyDefaultAction", "required": [ "action" ], "type": "object", "properties": { "logEnd": { "type": "boolean", "description": "Boolean indicating whether the device will log events at the end of the connection. Default is false." }, "logBegin": { "type": "boolean", "description": "Boolean indicating whether the device will log events at the beginning of the connection. Default is false." }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "snmpConfig": { "$ref": "#/components/schemas/IReference" }, "intrusionPolicy": { "$ref": "#/components/schemas/IIntrusionPolicyModel" }, "sendEventsToFMC": { "type": "boolean", "description": "Boolean indicating whether the device will send events to the Firepower Management Center event viewer. Default is false." }, "description": { "type": "string", "description": "User provided description." }, "type": { "type": "string", "description": "Response object associated with resource." }, "variableSet": { "$ref": "#/components/schemas/IReference" }, "version": { "type": "string", "description": "Version number of the response object." }, "syslogConfig": { "$ref": "#/components/schemas/IReference" }, "name": { "type": "string", "description": "User chosen resource name." }, "action": { "$ref": "#/components/schemas/Action" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string", "description": "Unique identifier representing resource." } } }, "PortMetadata": { "title": "PortMetadata", "type": "object", "properties": { "lastUser": { "$ref": "#/components/schemas/MetadataUser" }, "domain": { "$ref": "#/components/schemas/Domain" }, "readOnly": { "$ref": "#/components/schemas/ReadOnly" }, "parentType": { "type": "string" }, "timestamp": { "type": "integer", "format": "int32" } } }, "FPInterfaceStatisticsListContainer": { "title": "FPInterfaceStatisticsListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FPInterfaceStatistics" }, "description": "" } } }, "RangeObjectListContainer": { "title": "RangeObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RangeObject" }, "description": "" } } }, "RealmUser": { "title": "RealmUser", "type": "object", "properties": { "name": { "type": "string" }, "realmUuid": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "realm": { "$ref": "#/components/schemas/IRealm" }, "id": { "type": "string" }, "type": { "type": "string" } } }, "FTDSubInterfaceListContainer": { "title": "FTDSubInterfaceListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FTDSubInterface" }, "description": "" } } }, "ITarget": { "title": "ITarget", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "ISyslogConfig": { "title": "ISyslogConfig", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "RESTElement": { "title": "RESTElement", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "capabilities": { "type": "array", "items": { "type": "string" }, "description": "" }, "caCert": { "type": "string" }, "miscData": { "$ref": "#/components/schemas/LLMiscData" }, "description": { "type": "string" }, "cert": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "registrationDate": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "host": { "type": "string" }, "model": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "llelement": { "$ref": "#/components/schemas/LLElement" }, "key": { "type": "string" }, "status": { "type": "string" } } }, "DefaultAction": { "title": "DefaultAction", "required": [ "action" ], "type": "object", "properties": { "logEnd": { "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "logBegin": { "type": "boolean" }, "snmpConfig": { "$ref": "#/components/schemas/IReference" }, "intrusionPolicy": { "$ref": "#/components/schemas/IIntrusionPolicyModel" }, "sendEventsToFMC": { "type": "boolean" }, "description": { "type": "string" }, "type": { "type": "string" }, "variableSet": { "$ref": "#/components/schemas/IReference" }, "version": { "type": "string" }, "syslogConfig": { "$ref": "#/components/schemas/IReference" }, "name": { "type": "string" }, "action": { "$ref": "#/components/schemas/Action4" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" } } }, "NetworkObject": { "title": "NetworkObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "name": { "type": "string", "description": "User assigned resource name." }, "description": { "type": "string", "description": "User provided resource description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing response object." }, "type": { "type": "string", "description": "Type associated with resource: NetworkObject." }, "value": { "type": "string", "description": "Actual value of the network." }, "version": { "type": "string", "description": "Version number of the response object." }, "overrideTargetId": { "type": "string", "description": "Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain)." } }, "description": "A model representing Network object definition." }, "IHost": { "title": "IHost", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "version": { "type": "string" } } }, "FTDBridgeGroupInterface": { "title": "FTDBridgeGroupInterface", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "description": { "type": "string" }, "type": { "type": "string" }, "enabled": { "type": "boolean" }, "MTU": { "type": "integer", "format": "int32" }, "mode": { "$ref": "#/components/schemas/Mode" }, "arpConfig": { "type": "array", "items": { "$ref": "#/components/schemas/IARPConfigContainer" }, "description": "" }, "selectedInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/IInterface" }, "description": "" }, "ipv4": { "$ref": "#/components/schemas/IIPv4Container" }, "ifname": { "type": "string" }, "ipv6": { "$ref": "#/components/schemas/IIPv6Container" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "managementOnly": { "type": "boolean" }, "macLearn": { "type": "boolean" }, "enableAntiSpoofing": { "type": "boolean" }, "securityZone": { "$ref": "#/components/schemas/ISecurityZoneObjectModel" }, "activeMACAddress": { "type": "string" }, "fragmentReassembly": { "type": "boolean" }, "macTable": { "type": "array", "items": { "type": "string" }, "description": "" }, "bridgeGroupId": { "type": "integer", "format": "int32" }, "standbyMACAddress": { "type": "string" }, "ipAddress": { "type": "string" }, "enableDNSLookup": { "type": "boolean" }, "overrideDefaultFragmentSetting": { "$ref": "#/components/schemas/IOverrideDefaultFragmentSetting" }, "version": { "type": "string" }, "name": { "type": "string" } } }, "IAddressContainer": { "title": "IAddressContainer", "type": "object", "properties": { "address": { "type": "string" }, "enforceEUI64": { "type": "boolean" }, "prefix": { "type": "string" } } }, "IPv4StaticRouteModel": { "title": "IPv4StaticRouteModel", "required": [ "selectedNetworks", "metricValue", "interfaceName", "gateway" ], "type": "object", "properties": { "routeTracking": { "$ref": "#/components/schemas/ISLAMonitorModel" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "selectedNetworks": { "type": "array", "items": { "$ref": "#/components/schemas/INetworkAddress" }, "description": "" }, "metricValue": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "isTunneled": { "type": "boolean" }, "interfaceName": { "type": "string" }, "id": { "type": "string" }, "gateway": { "$ref": "#/components/schemas/IHostObjectContainer" } } }, "ApplicationTypeListContainer": { "title": "ApplicationTypeListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationType" }, "description": "" } } }, "ErrorMessagesContainer": { "title": "ErrorMessagesContainer", "type": "object", "properties": { "description": { "type": "string" } } }, "IOverride": { "title": "IOverride", "type": "object", "properties": { "parent": { "$ref": "#/components/schemas/IReference" }, "target": { "$ref": "#/components/schemas/IReference" } }, "description": "Defines the override details for this object." }, "IKEv2IPsecProposal": { "title": "IKEv2IPsecProposal", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "encryptionAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "integrityAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "ExtendedAccessListModelListContainer": { "title": "ExtendedAccessListModelListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedAccessListModel" }, "description": "" } } }, "FTDEtherChannelInterface": { "title": "FTDEtherChannelInterface", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "minActivePhysicalInterface": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "type": { "type": "string" }, "enabled": { "type": "boolean" }, "MTU": { "type": "integer", "format": "int32" }, "mode": { "$ref": "#/components/schemas/Mode" }, "arpConfig": { "type": "array", "items": { "$ref": "#/components/schemas/IARPConfigContainer" }, "description": "" }, "selectedInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/IInterface" }, "description": "" }, "etherChannelId": { "type": "integer", "format": "int32" }, "ipv4": { "$ref": "#/components/schemas/IIPv4Container" }, "ifname": { "type": "string" }, "ipv6": { "$ref": "#/components/schemas/IIPv6Container" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "lacpMode": { "$ref": "#/components/schemas/LacpMode" }, "hardware": { "$ref": "#/components/schemas/IHardwareContainer" }, "macLearn": { "type": "boolean" }, "managementOnly": { "type": "boolean" }, "enableAntiSpoofing": { "type": "boolean" }, "securityZone": { "$ref": "#/components/schemas/ISecurityZoneObjectModel" }, "activeMACAddress": { "type": "string" }, "fragmentReassembly": { "type": "boolean" }, "macTable": { "type": "array", "items": { "type": "string" }, "description": "" }, "standbyMACAddress": { "type": "string" }, "maxActivePhysicalInterface": { "type": "integer", "format": "int32" }, "enableDNSLookup": { "type": "boolean" }, "overrideDefaultFragmentSetting": { "$ref": "#/components/schemas/IOverrideDefaultFragmentSetting" }, "loadBalancing": { "$ref": "#/components/schemas/LoadBalancing" }, "version": { "type": "string" }, "erspanFlowId": { "type": "integer", "format": "int32" }, "erspanSourceIP": { "type": "string" }, "name": { "type": "string" } } }, "ContinentObject": { "title": "ContinentObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "code": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/ICountryModel" }, "description": "" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "DeployableDeviceListContainer": { "title": "DeployableDeviceListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeployableDevice" }, "description": "" } } }, "VlanTagGroup": { "title": "VlanTagGroup", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/IVlanModel" }, "description": "List of member vlan tags in this group" }, "literals": { "type": "array", "items": { "$ref": "#/components/schemas/IVlanTagLiteral" }, "description": "List of tag values in group." }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "name": { "type": "string", "description": "User assigned resource name." }, "description": { "type": "string", "description": "User provided resource description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource: VlanTagGroup." }, "version": { "type": "string", "description": "Version number of the response object." }, "overrideTargetId": { "type": "string", "description": "Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain)." } }, "description": "A model representing tag group definition." }, "URLCategory": { "title": "URLCategory", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "InterfaceObjectListContainer": { "title": "InterfaceObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/InterfaceObject" }, "description": "" } } }, "VlanTagListContainer": { "title": "VlanTagListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VlanTag" }, "description": "" } } }, "SNMPConfig": { "title": "SNMPConfig", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "DefaultActionListContainer": { "title": "DefaultActionListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultAction" }, "description": "" } } }, "ISecurityGroupTag": { "title": "ISecurityGroupTag", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "tag": { "type": "integer", "format": "int32" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "VirtualSwitch": { "title": "VirtualSwitch", "type": "object", "properties": { "dropBPDU": { "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "sensorPolicy": { "$ref": "#/components/schemas/IAccessPolicyModel" }, "description": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "strictTCPEnforcement": { "type": "boolean" }, "domainId": { "type": "integer", "format": "int32" }, "staticMacEntries": { "type": "array", "items": { "$ref": "#/components/schemas/IStaticMacEntry" }, "description": "" }, "name": { "type": "string" }, "switchedInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/IInterface" }, "description": "" }, "enableSpanningTreeProtocol": { "type": "boolean" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" }, "hybridInterface": { "$ref": "#/components/schemas/IInterface" } } }, "IApplicationType": { "title": "IApplicationType", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IUsersContainer": { "title": "IUsersContainer", "type": "object", "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/IRealmEntity" }, "description": "" } } }, "InterfaceEvent": { "title": "InterfaceEvent", "type": "object", "properties": { "hasPendingChanges": { "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "change": { "type": "string" }, "name": { "type": "string" }, "action": { "$ref": "#/components/schemas/Action5" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "state": { "$ref": "#/components/schemas/State" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "ISecurityZoneObjectModel": { "title": "ISecurityZoneObjectModel", "type": "object", "properties": { "interfaceMode": { "$ref": "#/components/schemas/InterfaceMode" }, "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/IFTDInterface" }, "description": "" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IYouTube": { "title": "IYouTube", "type": "object", "properties": { "siteKey": { "type": "string" }, "enabled": { "type": "boolean" } } }, "SecurityZoneObjectListContainer": { "title": "SecurityZoneObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityZoneObject" }, "description": "" } } }, "FTDHAIPv4Configuration": { "title": "FTDHAIPv4Configuration", "type": "object", "properties": { "standbyIPv4Address": { "type": "string" }, "activeIPv4Mask": { "type": "string" }, "activeIPv4Address": { "type": "string" } } }, "AnyProtocolPortObject": { "title": "AnyProtocolPortObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/PortMetadata" }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided resource description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier." }, "type": { "type": "string", "description": "Type associated with resource: AnyProtocolPortObject." }, "version": { "type": "string", "description": "Version number of the response object." }, "overrideTargetId": { "type": "string", "description": "Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain)." } }, "description": "A model representing Any portocol port object definition." }, "LLFeedConfig": { "title": "LLFeedConfig", "type": "object", "properties": { "safeToUpdate": { "type": "boolean" }, "feedContent": { "type": "string" }, "updatedObservables": { "type": "integer", "format": "int32" }, "safeToDelete": { "type": "boolean" }, "feedStatus": { "type": "string" }, "type": { "type": "string" }, "downloadOn": { "type": "boolean" }, "nextRun": { "type": "integer", "format": "int32" }, "password": { "type": "string" }, "totalUnsupportedObservables": { "type": "integer", "format": "int32" }, "property": { "$ref": "#/components/schemas/LLFeedProperty" }, "id": { "type": "string" }, "clientPrivateKey": { "type": "string" }, "totalUpdatedObservables": { "type": "integer", "format": "int32" }, "clientCert": { "type": "string" }, "subscribedCollections": { "type": "array", "items": { "$ref": "#/components/schemas/LLCollectionTopic" }, "description": "" }, "discardedObservables": { "type": "integer", "format": "int32" }, "finishTime": { "type": "integer", "format": "int32" }, "availableCollections": { "type": "array", "items": { "$ref": "#/components/schemas/LLCollectionTopic" }, "description": "" }, "lastRun": { "type": "integer", "format": "int32" }, "refreshSec": { "type": "integer", "format": "int32" }, "recurring": { "type": "boolean" }, "refreshMin": { "type": "integer", "format": "int32" }, "consumedObservables": { "type": "integer", "format": "int32" }, "params": { "$ref": "#/components/schemas/LLParams" }, "inRunningState": { "type": "boolean" }, "version": { "type": "string" }, "totalUpdatedIndicators": { "type": "integer", "format": "int32" }, "discoveryInfo": { "type": "array", "items": { "$ref": "#/components/schemas/LLCollectionTopic" }, "description": "" }, "statusMsg": { "$ref": "#/components/schemas/LLStatusMsg" }, "passwd": { "type": "string" }, "discardedIndicators": { "type": "integer", "format": "int32" }, "consumedUnsupportedObservables": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "totalDiscardedObservables": { "type": "integer", "format": "int32" }, "caCert": { "type": "string" }, "description": { "type": "string" }, "consumedIndicators": { "type": "integer", "format": "int32" }, "totalIndicators": { "type": "integer", "format": "int32" }, "totalObservables": { "type": "integer", "format": "int32" }, "checksum": { "type": "string" }, "delivery": { "type": "string" }, "proxyURL": { "type": "string" }, "runNow": { "type": "boolean" }, "updatedIndicators": { "type": "integer", "format": "int32" }, "totalConsumedIndicators": { "type": "integer", "format": "int32" }, "refresh": { "type": "integer", "format": "int32" }, "totalDiscardedIndicators": { "type": "integer", "format": "int32" }, "uri": { "type": "string" }, "passwdAsIs": { "type": "string" }, "startHour": { "type": "integer", "format": "int32" }, "feedType": { "type": "string" }, "totalConsumedObservables": { "type": "integer", "format": "int32" }, "username": { "type": "string" } } }, "URLCategoryListContainer": { "title": "URLCategoryListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/URLCategory" }, "description": "" } } }, "PortObjectGroupOverrideListContainer": { "title": "PortObjectGroupOverrideListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PortObjectGroupOverride" }, "description": "" } } }, "FTDHAMonitoredInterfaces": { "title": "FTDHAMonitoredInterfaces", "required": [ "monitorForFailures" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "monitorForFailures": { "type": "boolean", "description": "Flag indicating failure for monitored interfaces" }, "ipv6Configuration": { "$ref": "#/components/schemas/FTDHAIPv6Configuration" }, "name": { "type": "string", "description": "Name of the Firepower Threat Defense high availability monitored interface" }, "description": { "type": "string", "description": "Description of the Firepower Threat Defense high availability monitored interface" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string", "description": "Unique identifier (UUID) for the Firepower Threat Defense high availability monitored interface" }, "type": { "type": "string", "description": "Type of the Firepower Threat Defense high availability monitored interface" }, "version": { "type": "string", "description": "Firepower Threat Defense high availability monitored interface model version" }, "ipv4Configuration": { "$ref": "#/components/schemas/FTDHAIPv4Configuration" } }, "description": "Input representation of Firepower Threat Defense high availability monitored interface" }, "IDeviceGroup": { "title": "IDeviceGroup", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/IBaseDevice" }, "description": "" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "ICMPV6ObjectOverride": { "title": "ICMPV6ObjectOverride", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "INetworkObjectsContainer": { "title": "INetworkObjectsContainer", "type": "object", "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/INetworkBase" }, "description": "" }, "literals": { "type": "array", "items": { "$ref": "#/components/schemas/INetworkAddressLiteral" }, "description": "" } } }, "IMetadata": { "title": "IMetadata", "type": "object", "properties": { "lastUser": { "$ref": "#/components/schemas/IMetadataUser" }, "domain": { "$ref": "#/components/schemas/IDomain" }, "readOnly": { "$ref": "#/components/schemas/IReadonly" }, "timestamp": { "type": "integer", "format": "int32" } } }, "HostObject": { "title": "HostObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Set to 'true' if the object can be overridden, 'false' otherwise." }, "name": { "type": "string", "description": "The unique name for the object." }, "description": { "type": "string", "description": "A description about the object." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "The unique UUID of this object." }, "type": { "type": "string", "description": "The unique type of this object (fixed)." }, "value": { "type": "string", "description": "The Host IP address value for this object." }, "version": { "type": "string", "description": "The unique object version (if any)." }, "overrideTargetId": { "type": "string", "description": "The override target id either the device (UUID) or the domain (UUID) on which this override is created. Applicable only for overriden objects." } }, "description": "An object defining a Host Network object definition." }, "ContinentObjectListContainer": { "title": "ContinentObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContinentObject" }, "description": "" } } }, "ISNMPConfig": { "title": "ISNMPConfig", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "LLElement": { "title": "LLElement", "type": "object", "properties": { "capabilities": { "type": "array", "items": { "type": "string" }, "description": "" }, "caCert": { "type": "string" }, "description": { "type": "string" }, "miscData": { "$ref": "#/components/schemas/LLMiscData" }, "cert": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "name": { "type": "string" }, "registrationDate": { "type": "integer", "format": "int32" }, "action": { "type": "string" }, "model": { "type": "string" }, "id": { "type": "string" }, "key": { "type": "string" }, "status": { "type": "string" } } }, "RESTIndicatorEquationNode": { "title": "RESTIndicatorEquationNode", "type": "object", "properties": { "op": { "type": "string" }, "item": { "$ref": "#/components/schemas/LLEquationNode" }, "condition": { "type": "string" }, "isRealized": { "type": "boolean" }, "children": { "type": "array", "items": { "type": "object" }, "description": "" }, "type": { "type": "string" }, "value": { "type": "string" }, "applyCondition": { "type": "string" } } }, "HitCountListContainer": { "title": "HitCountListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/HitCount" }, "description": "List of all HitCount entries for given filter query on Access Policy." } }, "description": "List of all HitCount entries for given filter query on Access Policy." }, "UrlGroupOverride": { "title": "UrlGroupOverride", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Always returns false for overrides." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." } }, "description": "A model representing URL group override definition." }, "IReadonly": { "title": "IReadonly", "type": "object", "properties": { "reason": { "$ref": "#/components/schemas/Reason1" }, "state": { "type": "boolean" } } }, "FQDNObject": { "title": "FQDNObject", "required": [ "dnsResolution" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "dnsResolution": { "$ref": "#/components/schemas/DnsResolution" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "version": { "type": "string" }, "overrideTargetId": { "type": "string" } } }, "ApplicationRisk": { "title": "ApplicationRisk", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IFTDHAFailoverInterfacePolicyTrigger": { "title": "IFTDHAFailoverInterfacePolicyTrigger", "required": [ "peerHoldTimeUnit", "peerHoldTime", "interfacePollTime", "peerPollTime", "interfaceHoldTime", "peerPollTimeUnit", "interfacePollTimeUnit" ], "type": "object", "properties": { "percentFailedInterfaceExceed": { "type": "integer", "format": "int32" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "peerHoldTimeUnit": { "$ref": "#/components/schemas/PeerHoldTimeUnit" }, "description": { "type": "string" }, "peerHoldTime": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "version": { "type": "string" }, "interfacePollTime": { "type": "integer", "format": "int32" }, "noOfFailedInterfaceLimit": { "type": "integer", "format": "int32" }, "peerPollTime": { "type": "integer", "format": "int32" }, "interfaceHoldTime": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "peerPollTimeUnit": { "$ref": "#/components/schemas/PeerPollTimeUnit" }, "interfacePollTimeUnit": { "$ref": "#/components/schemas/InterfacePollTimeUnit" } } }, "DeviceStatusEntry": { "title": "DeviceStatusEntry", "type": "object", "properties": { "canBeDeployed": { "type": "boolean" }, "messageKey": { "$ref": "#/components/schemas/MessageKey" }, "policyStatusList": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyStatusEntry" }, "description": "" }, "domainName": { "type": "string" }, "isDeploying": { "type": "boolean" }, "deviceName": { "type": "string" }, "deviceUUID": { "type": "string" }, "selected": { "type": "boolean" }, "currentVersion": { "type": "integer", "format": "int32" } } }, "ISecurityZoneContainer": { "title": "ISecurityZoneContainer", "type": "object", "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/ISecurityZoneObjectModel" }, "description": "" } } }, "FTDBaseInterface": { "title": "FTDBaseInterface", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "enableAntiSpoofing": { "type": "boolean" }, "securityZone": { "$ref": "#/components/schemas/ISecurityZoneObjectModel" }, "activeMACAddress": { "type": "string" }, "fragmentReassembly": { "type": "boolean" }, "macTable": { "type": "array", "items": { "type": "string" }, "description": "" }, "standbyMACAddress": { "type": "string" }, "enableDNSLookup": { "type": "boolean" }, "description": { "type": "string" }, "overrideDefaultFragmentSetting": { "$ref": "#/components/schemas/IOverrideDefaultFragmentSetting" }, "type": { "type": "string" }, "version": { "type": "string" }, "enabled": { "type": "boolean" }, "MTU": { "type": "integer", "format": "int32" }, "mode": { "$ref": "#/components/schemas/Mode" }, "arpConfig": { "type": "array", "items": { "$ref": "#/components/schemas/IARPConfigContainer" }, "description": "" }, "ipv4": { "$ref": "#/components/schemas/IIPv4Container" }, "ifname": { "type": "string" }, "ipv6": { "$ref": "#/components/schemas/IIPv6Container" }, "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "macLearn": { "type": "boolean" }, "managementOnly": { "type": "boolean" } } }, "FTDClusterDeviceContainer": { "title": "FTDClusterDeviceContainer", "required": [ "masterDevice", "slaveDevices" ], "type": "object", "properties": { "masterDevice": { "$ref": "#/components/schemas/IDevice" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "modelId": { "type": "string", "description": "Model ID" }, "description": { "type": "string", "description": "User provided resource description." }, "slaveDevices": { "type": "array", "items": { "$ref": "#/components/schemas/IDevice" }, "description": "List of slave devices" }, "modelType": { "type": "string", "description": "Model type of the registered device cluster." }, "type": { "type": "string", "description": "Type associated with resource: DeviceCluster" }, "version": { "type": "string", "description": "Version number of the response object." }, "sw_version": { "type": "string", "description": "FTD Cluster version" }, "healthStatus": { "type": "string", "description": "Current health status of the device, for e.g. green" }, "healthPolicy": { "$ref": "#/components/schemas/IHealthPolicy" }, "name": { "type": "string", "description": "FTD Cluster name." }, "links": { "$ref": "#/components/schemas/ILinks" }, "model": { "type": "string", "description": "Cisco device model name, for e.g. Cisco Firepower 9000 Series SM-24 Threat Defense" }, "modelNumber": { "type": "string", "description": "Model number of the registered device." }, "id": { "type": "string", "description": "Unique identifier of response object." }, "accessPolicy": { "$ref": "#/components/schemas/IPolicyModel" } }, "description": "A model representing FTD Cluster Container" }, "IPv4StaticRouteModelListContainer": { "title": "IPv4StaticRouteModelListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IPv4StaticRouteModel" }, "description": "" } } }, "IVLanTagsContainer": { "title": "IVLanTagsContainer", "type": "object", "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/IVlanBase" }, "description": "" }, "literals": { "type": "array", "items": { "$ref": "#/components/schemas/IVlanTagLiteral" }, "description": "" } } }, "InlineSet": { "title": "InlineSet", "type": "object", "properties": { "macFiltering": { "type": "boolean" }, "loadBalancingModeVlan": { "type": "string" }, "tapMode": { "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "standBy": { "type": "boolean" }, "failOpenSnortBusy": { "type": "boolean" }, "description": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "strictTCPEnforcement": { "type": "boolean" }, "failopen": { "type": "boolean" }, "mtu": { "type": "integer", "format": "int32" }, "bypass": { "type": "boolean" }, "failSafe": { "type": "boolean" }, "loadBalancingMode": { "type": "string" }, "failOpenSnortDown": { "type": "boolean" }, "inlinepairs": { "type": "array", "items": { "$ref": "#/components/schemas/IInlinePair" }, "description": "" }, "name": { "type": "string" }, "propogateLinkState": { "type": "boolean" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" } } }, "IKeyObject": { "title": "IKeyObject", "type": "object", "properties": { "acceptLifeTime": { "$ref": "#/components/schemas/ILifeTime" }, "authAlgorithm": { "type": "string" }, "keyId": { "type": "integer", "format": "int32" }, "authString": { "$ref": "#/components/schemas/IAuthTypeAndString" }, "sendLifeTime": { "$ref": "#/components/schemas/ILifeTime" } } }, "EndPointDeviceType": { "title": "EndPointDeviceType", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "iseId": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "fqName": { "type": "string" }, "version": { "type": "string" } } }, "EndPointDeviceTypeListContainer": { "title": "EndPointDeviceTypeListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/EndPointDeviceType" }, "description": "" } } }, "Metadata": { "title": "Metadata", "type": "object", "properties": { "lastUser": { "$ref": "#/components/schemas/MetadataUser" }, "domain": { "$ref": "#/components/schemas/Domain" }, "readOnly": { "$ref": "#/components/schemas/ReadOnly" }, "timestamp": { "type": "integer", "description": "The last updated timestamp.", "format": "int32" } }, "description": "Defines read only details about the object - whether it is system defined, last user who modified the object etc." }, "ISLAMonitorModel": { "title": "ISLAMonitorModel", "required": [ "slaId", "interfaceObjects", "monitorAddress" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "noOfPackets": { "type": "integer", "format": "int32" }, "slaId": { "type": "integer", "format": "int32" }, "dataSize": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "threshold": { "type": "integer", "format": "int32" }, "interfaceNames": { "type": "array", "items": { "type": "string" }, "description": "" }, "type": { "type": "string" }, "version": { "type": "string" }, "timeout": { "type": "integer", "format": "int32" }, "interfaceObjects": { "type": "array", "items": { "$ref": "#/components/schemas/IInterfaceObjectModel" }, "description": "" }, "frequency": { "type": "integer", "format": "int32" }, "monitorAddress": { "type": "string" }, "name": { "type": "string" }, "tos": { "type": "integer", "format": "int32" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" } } }, "IIPv6Container": { "title": "IIPv6Container", "type": "object", "properties": { "linkLocalAddress": { "type": "string" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/IAddressContainer" }, "description": "" }, "raInterval": { "type": "integer", "format": "int32" }, "enableAutoConfig": { "type": "boolean" }, "nsInterval": { "type": "integer", "format": "int32" }, "prefixes": { "type": "array", "items": { "$ref": "#/components/schemas/IPrefixContainer" }, "description": "" }, "enforceEUI64": { "type": "boolean" }, "enableRA": { "type": "boolean" }, "dadAttempts": { "type": "integer", "format": "int32" }, "enableDHCPAddrConfig": { "type": "boolean" }, "enableDHCPNonAddrConfig": { "type": "boolean" }, "raLifeTime": { "type": "integer", "format": "int32" }, "enableIPV6": { "type": "boolean" }, "reachableTime": { "type": "integer", "format": "int32" } } }, "AccessRuleMetadata": { "title": "AccessRuleMetadata", "type": "object", "properties": { "lastUser": { "$ref": "#/components/schemas/MetadataUser" }, "ruleIndex": { "type": "integer", "format": "int32" }, "domain": { "$ref": "#/components/schemas/Domain" }, "readOnly": { "$ref": "#/components/schemas/ReadOnly" }, "section": { "type": "string" }, "accessPolicy": { "$ref": "#/components/schemas/IReference" }, "category": { "type": "string" }, "timestamp": { "type": "integer", "format": "int32" } } }, "IAccessRuleModel": { "title": "IAccessRuleModel", "required": [ "action" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "snmpConfig": { "$ref": "#/components/schemas/ISNMPConfig" }, "sourceNetworks": { "$ref": "#/components/schemas/INetworkObjectsContainer" }, "syslogSeverity": { "$ref": "#/components/schemas/SyslogSeverity" }, "sourceZones": { "$ref": "#/components/schemas/ISourceZoneContainer" }, "destinationZones": { "$ref": "#/components/schemas/ISecurityZoneContainer" }, "description": { "type": "string" }, "originalSourceNetworks": { "$ref": "#/components/schemas/INetworkObjectsContainer" }, "enableSyslog": { "type": "boolean" }, "type": { "type": "string" }, "safeSearch": { "$ref": "#/components/schemas/ISafeSearch" }, "enabled": { "type": "boolean" }, "syslogConfig": { "$ref": "#/components/schemas/ISyslogConfig" }, "urls": { "$ref": "#/components/schemas/IUrlObjectsContainer" }, "endPointDeviceTypes": { "type": "array", "items": { "$ref": "#/components/schemas/IEndPointDeviceType" }, "description": "" }, "destinationNetworks": { "$ref": "#/components/schemas/INetworkObjectsContainer" }, "youTube": { "$ref": "#/components/schemas/IYouTube" }, "action": { "$ref": "#/components/schemas/Action1" }, "networkAccessDeviceIPs": { "$ref": "#/components/schemas/INetworkObjectsContainer" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "sourceSecurityGroupTags": { "$ref": "#/components/schemas/ISecurityGroupTagContainer" }, "logEnd": { "type": "boolean" }, "logBegin": { "type": "boolean" }, "sendEventsToFMC": { "type": "boolean" }, "destinationPorts": { "$ref": "#/components/schemas/IPortObjectsContainer" }, "sourcePorts": { "$ref": "#/components/schemas/IPortObjectsContainer" }, "ipsPolicy": { "$ref": "#/components/schemas/IIntrusionPolicyModel" }, "variableSet": { "$ref": "#/components/schemas/IVariableSet" }, "version": { "type": "string" }, "users": { "$ref": "#/components/schemas/IUsersContainer" }, "logFiles": { "type": "boolean" }, "newComments": { "type": "array", "items": { "type": "string" }, "description": "" }, "commentHistoryList": { "type": "array", "items": { "$ref": "#/components/schemas/ICommentHistory" }, "description": "" }, "filePolicy": { "$ref": "#/components/schemas/IFilePolicy" }, "name": { "type": "string" }, "vlanTags": { "$ref": "#/components/schemas/IVLanTagsContainer" }, "applications": { "$ref": "#/components/schemas/IApplicationsContainer" } } }, "IApplicationsContainer": { "title": "IApplicationsContainer", "type": "object", "properties": { "inlineApplicationFilters": { "type": "array", "items": { "$ref": "#/components/schemas/IAppCondition" }, "description": "" }, "applicationFilters": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationFilter" }, "description": "" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationModel" }, "description": "" } } }, "NetworkGroup": { "title": "NetworkGroup", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/INetworkAddress" }, "description": "The list of member network objects" }, "literals": { "type": "array", "items": { "$ref": "#/components/schemas/INetworkAddressLiteral" }, "description": "List of network values in group." }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided resource description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier of response object." }, "type": { "type": "string", "description": "Type associated with resource: NetworkGroup." }, "version": { "type": "string", "description": "Version number of the response object." }, "overrideTargetId": { "type": "string", "description": "Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain)." } }, "description": "A model representing Network group definition." }, "HitCountMetadata": { "title": "HitCountMetadata", "type": "object", "properties": { "lastUser": { "$ref": "#/components/schemas/MetadataUser" }, "task": { "$ref": "#/components/schemas/ITaskStatus" }, "ruleIndex": { "type": "integer", "description": "Index number of the rule in the access control or prefilter policy list, against which the hit count information is retrieved.", "format": "int32" }, "domain": { "$ref": "#/components/schemas/Domain" }, "deviceRuleId": { "type": "string", "description": "ID of the rule on the target device console." }, "timestamp": { "type": "integer", "format": "int32" }, "policy": { "$ref": "#/components/schemas/IPolicyModel" } } }, "SIURLFeed": { "title": "SIURLFeed", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "feedURL": { "type": "string" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "checksumURL": { "type": "string" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" }, "updateFrequency": { "type": "integer", "format": "int32" } } }, "PreferLifeTime": { "title": "PreferLifeTime", "type": "object", "properties": { "duration": { "$ref": "#/components/schemas/Duration" }, "expirationLifeTime": { "$ref": "#/components/schemas/ExpirationLifeTime" } } }, "LLParams": { "title": "LLParams", "type": "object", "properties": { "additionalProperties": { "type": "string" } } }, "RESTTidSourceListContainer": { "title": "RESTTidSourceListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RESTTidSource" }, "description": "" } } }, "IFTDHAIPv6ActiveStandbyPair": { "title": "IFTDHAIPv6ActiveStandbyPair", "type": "object", "properties": { "activeIPv6": { "type": "string" }, "standbyIPv6": { "type": "string" } } }, "IHostObjectContainer": { "title": "IHostObjectContainer", "type": "object", "properties": { "object": { "$ref": "#/components/schemas/IHost" }, "literal": { "$ref": "#/components/schemas/INetworkAddressLiteral" } } }, "IAccessPolicyModel": { "title": "IAccessPolicyModel", "required": [ "defaultAction" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "defaultAction": { "$ref": "#/components/schemas/IAccessPolicyDefaultAction" }, "name": { "type": "string" }, "description": { "type": "string" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/IAccessRuleModel" }, "description": "" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IProtocolPortObject": { "title": "IProtocolPortObject", "type": "object", "properties": { "protocol": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "port": { "type": "string" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "StaticRouteModelListContainer": { "title": "StaticRouteModelListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/StaticRouteModel" }, "description": "" } } }, "IVpnIkev2Settings": { "title": "IVpnIkev2Settings", "type": "object", "properties": { "automaticPreSharedKeyLength": { "type": "integer", "format": "int32" }, "certificateAuth": { "$ref": "#/components/schemas/IReference" }, "enforceHexBasedPreSharedKeyOnly": { "type": "boolean" }, "authenticationType": { "$ref": "#/components/schemas/AuthenticationType" }, "manualPreSharedKey": { "type": "string", "description": "Contains the manual pre-shared key for the VPN, if any." }, "policy": { "$ref": "#/components/schemas/IReference" } }, "description": "Contains information about Internet Key Exchange version 2 settings for VPNs." }, "FTDManualNatRuleListContainer": { "title": "FTDManualNatRuleListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FTDManualNatRule" }, "description": "" } } }, "IRealm": { "title": "IRealm", "type": "object", "properties": { "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" } } }, "RangeOverride": { "title": "RangeOverride", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Always returns false for overrides." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." } }, "description": "A model representing range object override definition." }, "AccessRuleListContainer": { "title": "AccessRuleListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccessRule" }, "description": "" } } }, "IFTDInterface": { "title": "IFTDInterface", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "SLAMonitorObjectModelListContainer": { "title": "SLAMonitorObjectModelListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SLAMonitorObjectModel" }, "description": "" } } }, "DeploymentRequestMetadata": { "title": "DeploymentRequestMetadata", "type": "object", "properties": { "lastUser": { "$ref": "#/components/schemas/MetadataUser" }, "task": { "$ref": "#/components/schemas/TaskStatus" }, "domain": { "$ref": "#/components/schemas/Domain" }, "readOnly": { "$ref": "#/components/schemas/ReadOnly" }, "timestamp": { "type": "integer", "format": "int32" } } }, "AuditModelListContainer": { "title": "AuditModelListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AuditModel" }, "description": "" } } }, "AuditModel": { "title": "AuditModel", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "subSystem": { "type": "string" }, "description": { "type": "string" }, "source": { "type": "string" }, "type": { "type": "string" }, "message": { "type": "string" }, "version": { "type": "string" }, "domain": { "type": "string" }, "name": { "type": "string" }, "startTime": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "endTime": { "type": "string" }, "id": { "type": "string" }, "time": { "type": "integer", "format": "int32" }, "username": { "type": "string" } } }, "FTDPhysicalInterface": { "title": "FTDPhysicalInterface", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "description": { "type": "string" }, "type": { "type": "string" }, "enabled": { "type": "boolean" }, "MTU": { "type": "integer", "format": "int32" }, "mode": { "$ref": "#/components/schemas/Mode" }, "arpConfig": { "type": "array", "items": { "$ref": "#/components/schemas/IARPConfigContainer" }, "description": "" }, "ipv4": { "$ref": "#/components/schemas/IIPv4Container" }, "ifname": { "type": "string" }, "ipv6": { "$ref": "#/components/schemas/IIPv6Container" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "lacpMode": { "$ref": "#/components/schemas/LacpMode" }, "hardware": { "$ref": "#/components/schemas/IHardwareContainer" }, "macLearn": { "type": "boolean" }, "managementOnly": { "type": "boolean" }, "channelGroupId": { "type": "integer", "format": "int32" }, "enableAntiSpoofing": { "type": "boolean" }, "securityZone": { "$ref": "#/components/schemas/ISecurityZoneObjectModel" }, "isRedundantMember": { "type": "boolean" }, "activeMACAddress": { "type": "string" }, "fragmentReassembly": { "type": "boolean" }, "macTable": { "type": "array", "items": { "type": "string" }, "description": "" }, "standbyMACAddress": { "type": "string" }, "enableDNSLookup": { "type": "boolean" }, "overrideDefaultFragmentSetting": { "$ref": "#/components/schemas/IOverrideDefaultFragmentSetting" }, "version": { "type": "string" }, "erspanFlowId": { "type": "integer", "format": "int32" }, "erspanSourceIP": { "type": "string" }, "name": { "type": "string" } } }, "ReadOnly": { "title": "ReadOnly", "type": "object", "properties": { "reason": { "$ref": "#/components/schemas/Reason" }, "state": { "type": "boolean", "description": "True if this resource us read only and false otherwise." } }, "description": "Defines the read only conditions if the referenced resource is read only." }, "NetworkGroupOverrideListContainer": { "title": "NetworkGroupOverrideListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkGroupOverride" }, "description": "" } } }, "FPPhysicalInterfaceListContainer": { "title": "FPPhysicalInterfaceListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FPPhysicalInterface" }, "description": "" } } }, "IFTDDeviceHABootStrap": { "title": "IFTDDeviceHABootStrap", "required": [ "lanFailover", "useSameLinkForFailovers", "statefulFailover" ], "type": "object", "properties": { "sharedKey": { "type": "string" }, "lanFailover": { "$ref": "#/components/schemas/IFTDDeviceHAFailoverLink" }, "encKeyGenerationScheme": { "$ref": "#/components/schemas/EncKeyGenerationScheme" }, "useSameLinkForFailovers": { "type": "boolean" }, "isEncryptionEnabled": { "type": "boolean" }, "statefulFailover": { "$ref": "#/components/schemas/IFTDDeviceHAFailoverLink" } } }, "DeviceListContainer": { "title": "DeviceListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Device" }, "description": "" } } }, "VpnEndpointListContainer": { "title": "VpnEndpointListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VpnEndpoint" }, "description": "" } } }, "ICMPV6Object": { "title": "ICMPV6Object", "type": "object", "properties": { "icmpType": { "type": "string", "description": "ICMP type number." }, "metadata": { "$ref": "#/components/schemas/PortMetadata" }, "code": { "type": "integer", "description": "ICMP code number.", "format": "int32" }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided resource description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier." }, "type": { "type": "string", "description": "Type associated with resource: ICMPV6Object." }, "version": { "type": "string", "description": "Version number of the response object." }, "overrideTargetId": { "type": "string", "description": "Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain)." } }, "description": "An object defining a ICMPv6 Port object definition." }, "LLObservationData": { "title": "LLObservationData", "type": "object", "properties": { "actionTaken": { "type": "string" }, "miscData": { "$ref": "#/components/schemas/LLMiscData" }, "type": { "type": "string" }, "value": { "type": "string" } } }, "CountryObject": { "title": "CountryObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "iso2": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "iso3": { "type": "string" } } }, "ApplicationType": { "title": "ApplicationType", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "PolicyStatusEntry": { "title": "PolicyStatusEntry", "type": "object", "properties": { "isUpToDate": { "type": "boolean" }, "policyId": { "type": "string" }, "policyName": { "type": "string" }, "policyType": { "type": "string" }, "referredPolicyList": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyStatusEntry" }, "description": "" }, "currentVersion": { "type": "integer", "format": "int32" }, "isHidden": { "type": "boolean" } } }, "LLSettings": { "title": "LLSettings", "type": "object", "properties": { "additionalProperties": { "type": "object" } } }, "DeploymentRequest": { "title": "DeploymentRequest", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/DeploymentRequestMetadata" }, "forceDeploy": { "type": "boolean" }, "name": { "type": "string" }, "deviceList": { "type": "array", "items": { "type": "string" }, "description": "" }, "ignoreWarning": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "ApplicableDevice": { "title": "ApplicableDevice", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "isPartOfContainer": { "type": "string" }, "modelId": { "type": "string" }, "containerType": { "type": "string" }, "description": { "type": "string" }, "modelType": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "upgradePackage": { "$ref": "#/components/schemas/UpgradePackage" }, "sw_version": { "type": "string" }, "healthStatus": { "type": "string" }, "healthPolicy": { "$ref": "#/components/schemas/IHealthPolicy" }, "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "model": { "type": "string" }, "modelNumber": { "type": "string" }, "id": { "type": "string" }, "accessPolicy": { "$ref": "#/components/schemas/IPolicyModel" } } }, "InterfaceGroupObject": { "title": "InterfaceGroupObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/IFTDInterface" }, "description": "" }, "interfaceMode": { "$ref": "#/components/schemas/InterfaceMode2" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" }, "interfaceGroup": { "type": "integer", "format": "int32" } } }, "Domain": { "title": "Domain", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the domain." }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string", "description": "Unique UUID of this domain" }, "type": { "type": "string", "description": "Domain type definition (fixed)." } }, "description": "The details about the domain." }, "RealmUserGroupListContainer": { "title": "RealmUserGroupListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RealmUserGroup" }, "description": "" } } }, "INetworkAddressLiteral": { "title": "INetworkAddressLiteral", "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" } } }, "IARPConfigContainer": { "title": "IARPConfigContainer", "type": "object", "properties": { "macAddress": { "type": "string" }, "enableAlias": { "type": "boolean" }, "ipAddress": { "type": "string" } } }, "VpnPKIEnrollmentModelListContainer": { "title": "VpnPKIEnrollmentModelListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VpnPKIEnrollmentModel" }, "description": "" } } }, "INetworkObjectsOnly": { "title": "INetworkObjectsOnly", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "AccessPolicyLoggingSettingModelListContainer": { "title": "AccessPolicyLoggingSettingModelListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccessPolicyLoggingSettingModel" }, "description": "" } } }, "HitCount": { "title": "HitCount", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/HitCountMetadata" }, "lastFetchTimeStamp": { "type": "string", "description": "Indicates the last time (in ISO 8601 format) the hit count was retrieved for the mentioned rule." }, "hitCount": { "type": "integer", "description": "Indicates the number of times the access control rule was hit on the target device. It is based on the data from the last FMC hit count refresh operation.", "format": "int32" }, "firstHitTimeStamp": { "type": "string", "description": "Indicates the time (in ISO 8601 format) when the hit count was first hit for the mentioned rule." }, "rule": { "$ref": "#/components/schemas/IPolicyModel" }, "lastHitTimeStamp": { "type": "string", "description": "Indicates the time (in ISO 8601 format) when the hit count was last hit for the mentioned rule." }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "type": { "type": "string", "description": "Type must be HitCount." }, "version": { "type": "string" } } }, "KeyChainObjectOverrideListContainer": { "title": "KeyChainObjectOverrideListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/KeyChainObjectOverride" }, "description": "" } } }, "UrlOverride": { "title": "UrlOverride", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Always returns false for overrides." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." } }, "description": "A model representing URL object override definition." }, "AccessPolicyListContainer": { "title": "AccessPolicyListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccessPolicy" }, "description": "" } } }, "ITaskStatus": { "title": "ITaskStatus", "type": "object", "properties": { "taskType": { "$ref": "#/components/schemas/TaskType" }, "subTasks": { "type": "array", "items": { "$ref": "#/components/schemas/ISubTask" }, "description": "" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "message": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" } } }, "Ikev1PolicyObjectListContainer": { "title": "Ikev1PolicyObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Ikev1PolicyObject" }, "description": "" } } }, "DeviceGroupListContainer": { "title": "DeviceGroupListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceGroup" }, "description": "" } } }, "RESTTidSource": { "title": "RESTTidSource", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "caCert": { "type": "string" }, "feedContent": { "type": "string" }, "description": { "type": "string" }, "invalidObservables": { "type": "integer", "format": "int32" }, "feedStatus": { "type": "string" }, "type": { "type": "string" }, "downloadOn": { "type": "boolean" }, "nextRun": { "type": "integer", "format": "int32" }, "consumedIndicators": { "type": "integer", "format": "int32" }, "totalObservables": { "type": "integer", "format": "int32" }, "totalIndicators": { "type": "integer", "format": "int32" }, "totalUnsupportedObservables": { "type": "integer", "format": "int32" }, "property": { "$ref": "#/components/schemas/RESTFeedProperty" }, "checksum": { "type": "string" }, "llfeedConfig": { "$ref": "#/components/schemas/LLFeedConfig" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "clientPrivateKey": { "type": "string" }, "subscribedCollections": { "type": "array", "items": { "$ref": "#/components/schemas/RESTCollectionTopic" }, "description": "" }, "delivery": { "type": "string" }, "clientCert": { "type": "string" }, "finishTime": { "type": "integer", "format": "int32" }, "availableCollections": { "type": "array", "items": { "$ref": "#/components/schemas/RESTCollectionTopic" }, "description": "" }, "lastRun": { "type": "integer", "format": "int32" }, "runNow": { "type": "boolean" }, "consumedObservables": { "type": "integer", "format": "int32" }, "totalDiscardedIndicators": { "type": "integer", "format": "int32" }, "refresh": { "type": "integer", "format": "int32" }, "params": { "$ref": "#/components/schemas/LLParams" }, "uri": { "type": "string" }, "feedConfig": { "$ref": "#/components/schemas/LLFeedConfig" }, "version": { "type": "string" }, "discoveryInfo": { "type": "array", "items": { "$ref": "#/components/schemas/RESTCollectionTopic" }, "description": "" }, "totalInvalidObservables": { "type": "integer", "format": "int32" }, "statusMsg": { "$ref": "#/components/schemas/LLStatusMsg" }, "passwd": { "type": "string" }, "startHour": { "type": "integer", "format": "int32" }, "consumedUnsupportedObservables": { "type": "integer", "format": "int32" }, "discardedIndicators": { "type": "integer", "format": "int32" }, "feedType": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" } } }, "LLFeedProperty": { "title": "LLFeedProperty", "type": "object", "properties": { "expirationTime": { "type": "integer", "format": "int32" }, "publish": { "type": "boolean" }, "action": { "type": "string" }, "whitelist": { "type": "boolean" }, "ttl": { "type": "integer", "format": "int32" }, "tags": { "$ref": "#/components/schemas/LLTags" } } }, "LLIndicator": { "title": "LLIndicator", "type": "object", "properties": { "pending": { "type": "array", "items": { "type": "string" }, "description": "" }, "description": { "type": "string" }, "rawData": { "type": "string" }, "type": { "type": "string" }, "noRealizedIncidents": { "type": "integer", "format": "int32" }, "observables": { "type": "array", "items": { "$ref": "#/components/schemas/LLObservable" }, "description": "" }, "stale": { "type": "boolean" }, "unsupported": { "type": "boolean" }, "feedId": { "type": "string" }, "effectiveProperty": { "$ref": "#/components/schemas/LLFeedProperty" }, "action": { "type": "string" }, "id": { "type": "string" }, "noPartialIncidents": { "type": "integer", "format": "int32" }, "customProperty": { "$ref": "#/components/schemas/LLFeedProperty" }, "updatedAt": { "type": "integer", "format": "int32" }, "equation": { "$ref": "#/components/schemas/LLEquationNode" }, "version": { "type": "string" }, "ttl": { "type": "integer", "format": "int32" }, "tags": { "$ref": "#/components/schemas/LLTags" }, "indicatorVersion": { "type": "string" }, "expirationTime": { "type": "integer", "format": "int32" }, "publish": { "type": "boolean" }, "name": { "type": "string" }, "invalid": { "type": "boolean" }, "sourceName": { "type": "string" }, "inheritedProperty": { "$ref": "#/components/schemas/LLFeedProperty" }, "fileId": { "type": "string" } } }, "PortObjectGroupListContainer": { "title": "PortObjectGroupListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PortObjectGroup" }, "description": "" } } }, "IStaticMacEntry": { "title": "IStaticMacEntry", "type": "object", "properties": { "interface": { "$ref": "#/components/schemas/IInterface" }, "mac": { "type": "string" } } }, "VpnIPSecSettingsListContainer": { "title": "VpnIPSecSettingsListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VpnIPSecSettings" }, "description": "" } } }, "Realm": { "title": "Realm", "type": "object", "properties": { "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" } } }, "ApplicationFilterListContainer": { "title": "ApplicationFilterListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationFilter" }, "description": "" } } }, "IUrlModel": { "title": "IUrlModel", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "url": { "type": "string" } } }, "ApplicationCategoryListContainer": { "title": "ApplicationCategoryListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationCategory" }, "description": "" } } }, "IVpnExtranetInfo": { "title": "IVpnExtranetInfo", "type": "object", "properties": { "isDynamicIP": { "type": "boolean", "description": "Indicates whether the VPN endpoint has a dynamic IP." }, "name": { "type": "string", "description": "User chosen resource name." }, "ipAddress": { "type": "string", "description": "IP address of the VPN endpoint." } }, "description": "Contains VPN extranet information." }, "ISecurityGroupTagContainer": { "title": "ISecurityGroupTagContainer", "type": "object", "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/ISecurityGroupTag" }, "description": "" }, "literals": { "type": "array", "items": { "$ref": "#/components/schemas/ISecurityGroupTagLiteral" }, "description": "" } } }, "FTDNatRuleListContainer": { "title": "FTDNatRuleListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FTDNatRule" }, "description": "" } } }, "FTDHAIPv6Configuration": { "title": "FTDHAIPv6Configuration", "type": "object", "properties": { "ipv6ActiveStandbyPair": { "type": "array", "items": { "$ref": "#/components/schemas/IFTDHAIPv6ActiveStandbyPair" }, "description": "" }, "activeIPv6LinkLocalAddress": { "type": "string" }, "standbyIPv6LinkLocalAddress": { "type": "string" } } }, "DeployableDevice": { "title": "DeployableDevice", "type": "object", "properties": { "deviceMembers": { "type": "array", "items": { "$ref": "#/components/schemas/IDevice" }, "description": "" }, "canBeDeployed": { "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "policyStatusList": { "type": "array", "items": { "$ref": "#/components/schemas/IPolicyStatus" }, "description": "" }, "description": { "type": "string" }, "message": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "entry": { "$ref": "#/components/schemas/DeviceStatusEntry" }, "upToDate": { "type": "boolean" }, "domain": { "$ref": "#/components/schemas/IDomain" }, "isDeploying": { "type": "boolean" }, "isSelected": { "type": "boolean" }, "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "trafficInterruption": { "$ref": "#/components/schemas/TrafficInterruption" }, "device": { "$ref": "#/components/schemas/IDevice" }, "group": { "$ref": "#/components/schemas/IDeviceGroup" } } }, "FTDClusterDeviceContainerListContainer": { "title": "FTDClusterDeviceContainerListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FTDClusterDeviceContainer" }, "description": "" } } }, "ISourceZoneContainer": { "title": "ISourceZoneContainer", "type": "object", "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/ISourceZoneObject" }, "description": "" } } }, "SecurityGroupTag": { "title": "SecurityGroupTag", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "tag": { "type": "integer", "format": "int32" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IPrefixContainer": { "title": "IPrefixContainer", "type": "object", "properties": { "default": { "type": "boolean" }, "address": { "type": "string" }, "advertisement": { "$ref": "#/components/schemas/IAdvertisement" } } }, "SNMPConfigListContainer": { "title": "SNMPConfigListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SNMPConfig" }, "description": "" } } }, "DNSServerGroupObjectListContainer": { "title": "DNSServerGroupObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DNSServerGroupObject" }, "description": "" } } }, "KeyChainObjectOverride": { "title": "KeyChainObjectOverride", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "RESTIncident": { "title": "RESTIncident", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "indicatorName": { "type": "string" }, "equation": { "$ref": "#/components/schemas/RESTIndicatorEquationNode" }, "description": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "iteratorId": { "type": "string" }, "indicatorId": { "type": "string" }, "actionTaken": { "type": "string" }, "feedId": { "type": "string" }, "observations": { "type": "array", "items": { "$ref": "#/components/schemas/RESTObservation" }, "description": "" }, "property": { "$ref": "#/components/schemas/RESTFeedProperty" }, "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "sourceName": { "type": "string" }, "realizedAt": { "type": "integer", "format": "int32" }, "llincident": { "$ref": "#/components/schemas/LLIncident" }, "id": { "type": "string" }, "status": { "type": "string" }, "updatedAt": { "type": "integer", "format": "int32" } } }, "IPPPoEContianer": { "title": "IPPPoEContianer", "type": "object", "properties": { "pppoePassword": { "type": "string" }, "pppoeRouteMetric": { "type": "integer", "format": "int32" }, "ipAddress": { "type": "string" }, "vpdnGroupName": { "type": "string" }, "pppAuth": { "$ref": "#/components/schemas/PppAuth" }, "enableRouteSettings": { "type": "boolean" }, "storeCredsInFlash": { "type": "boolean" }, "pppoeUser": { "type": "string" } } }, "ApplicableDeviceListContainer": { "title": "ApplicableDeviceListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicableDevice" }, "description": "" } } }, "IDHCPContainer": { "title": "IDHCPContainer", "type": "object", "properties": { "dhcpRouteMetric": { "type": "integer", "format": "int32" }, "enableDefaultRouteDHCP": { "type": "boolean" } } }, "ProtocolPortObject": { "title": "ProtocolPortObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/PortMetadata" }, "protocol": { "type": "string", "description": "IANA protocol number or Ethertype. This is handled differently for Transport and Network layer protocols. Transport layer protocols are identified by the IANA protocol number. For example: • 6 — TCP • 17 — UDP Network layer protocols are identified by the decimal form of the IEEE Registration Authority Ethertype. For example: • 2048 — IP." }, "port": { "type": "string", "description": "Port number for the object." }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be override." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." }, "overrideTargetId": { "type": "string", "description": "Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain)." } }, "description": "A model representing protocol port object definition." }, "ICMPV4ObjectOverride": { "title": "ICMPV4ObjectOverride", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "UpgradePackageListContainer": { "title": "UpgradePackageListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UpgradePackage" }, "description": "" } } }, "VlanTagGroupListContainer": { "title": "VlanTagGroupListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VlanTagGroup" }, "description": "" } } }, "PortObjectGroupOverride": { "title": "PortObjectGroupOverride", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." } }, "description": "A model representing port object group override definition." }, "VariableSet": { "title": "VariableSet", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IHealthPolicy": { "title": "IHealthPolicy", "type": "object", "properties": { "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" } } }, "LLAdditionalProperties": { "title": "LLAdditionalProperties", "type": "object", "properties": { "additionalProperties": { "type": "string" } } }, "FPLogicalInterface": { "title": "FPLogicalInterface", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "securityZone": { "$ref": "#/components/schemas/ISecurityZoneObjectModel" }, "vlanTag": { "type": "integer", "format": "int32" }, "virtualSwitch": { "$ref": "#/components/schemas/IVirtualSwitch" }, "icmpEnabled": { "type": "integer", "format": "int32" }, "physicalInterface": { "$ref": "#/components/schemas/IFPPhysicalInterface" }, "description": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "enabled": { "type": "integer", "format": "int32" }, "mtu": { "type": "integer", "format": "int32" }, "mode": { "type": "string" }, "interfaceType": { "$ref": "#/components/schemas/InterfaceType2" }, "mdi": { "type": "string" }, "name": { "type": "string" }, "staticArpEntries": { "type": "array", "items": { "$ref": "#/components/schemas/IStaticArpEntry" }, "description": "" }, "links": { "$ref": "#/components/schemas/Links" }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "" }, "id": { "type": "string" } } }, "RESTObservable": { "title": "RESTObservable", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "description": { "type": "string" }, "observableType": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "indicatorCount": { "type": "integer", "format": "int32" }, "effectiveProperty": { "$ref": "#/components/schemas/RESTFeedProperty" }, "observable": { "$ref": "#/components/schemas/LLObservable" }, "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "value": { "type": "string" }, "inheritedProperty": { "$ref": "#/components/schemas/RESTFeedProperty" }, "customProperty": { "$ref": "#/components/schemas/RESTFeedProperty" }, "updatedAt": { "type": "integer", "format": "int32" } } }, "MetadataUser": { "title": "MetadataUser", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the user." }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string", "description": "The unique UUID of the user" }, "type": { "type": "string", "description": "The user type (fixed)." } }, "description": "This object defines details about the user." }, "FQDNOverride": { "title": "FQDNOverride", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Always return false for overrides." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." } }, "description": "A model representing FQDN Network object override definition." }, "VpnIkeSettings": { "title": "VpnIkeSettings", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "ikeV1Settings": { "$ref": "#/components/schemas/IVpnIkev1Settings" }, "type": { "type": "string" }, "ikeV2Settings": { "$ref": "#/components/schemas/IVpnIkev2Settings" }, "version": { "type": "string" } } }, "TunnelTags": { "title": "TunnelTags", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "CloudEvents": { "title": "CloudEvents", "type": "object", "properties": { "sendIntrusionEvents": { "type": "boolean", "description": "Boolean indicating whether to send intrusion events to cloud" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string", "description": "Unique UUID of the configuration object" }, "type": { "type": "string", "description": "Type of the configuration object: CloudEventsConfigs" }, "version": { "type": "string" } }, "description": "details of the configuration object for sending events to cloud" }, "IntrusionPolicy": { "title": "IntrusionPolicy", "type": "object", "properties": { "inlineDrop": { "type": "integer", "format": "int32" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "basePolicy": { "$ref": "#/components/schemas/IIntrusionPolicyModel" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "FTDRedundantInterfaceListContainer": { "title": "FTDRedundantInterfaceListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FTDRedundantInterface" }, "description": "" } } }, "RangeOverrideListContainer": { "title": "RangeOverrideListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RangeOverride" }, "description": "" } } }, "INetworkBase": { "title": "INetworkBase", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IVpnProtectedNetwork": { "title": "IVpnProtectedNetwork", "type": "object", "properties": { "acl": { "$ref": "#/components/schemas/IReference" }, "networks": { "type": "array", "items": { "$ref": "#/components/schemas/IReference" }, "description": "Represents networks in the VPN." } }, "description": "Contains information about VPN networks." }, "KeyChainObject": { "title": "KeyChainObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "keys": { "type": "array", "items": { "$ref": "#/components/schemas/IKeyObject" }, "description": "" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" }, "overrideTargetId": { "type": "string" } } }, "ExtendedAccessListModel": { "title": "ExtendedAccessListModel", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "KeyChainObjectListContainer": { "title": "KeyChainObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/KeyChainObject" }, "description": "" } } }, "ICMPV4ObjectListContainer": { "title": "ICMPV4ObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ICMPV4Object" }, "description": "" } } }, "UrlOverrideListContainer": { "title": "UrlOverrideListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UrlOverride" }, "description": "" } } }, "IApplicationModel": { "title": "IApplicationModel", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "deprecated": { "type": "boolean" }, "description": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationTag" }, "description": "" }, "productivity": { "$ref": "#/components/schemas/IApplicationProductivity" }, "appId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "applicationTypes": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationType" }, "description": "" }, "risk": { "$ref": "#/components/schemas/IApplicationRisk" }, "links": { "$ref": "#/components/schemas/ILinks" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/IApplicationCategory" }, "description": "" }, "id": { "type": "string" } } }, "URLObjectListContainer": { "title": "URLObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/URLObject" }, "description": "" } } }, "IPv6StaticRouteModel": { "title": "IPv6StaticRouteModel", "required": [ "selectedNetworks", "metricValue", "interfaceName", "gateway" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "selectedNetworks": { "type": "array", "items": { "$ref": "#/components/schemas/INetworkAddress" }, "description": "" }, "metricValue": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "isTunneled": { "type": "boolean" }, "interfaceName": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "gateway": { "$ref": "#/components/schemas/IHostObjectContainer" } } }, "INetworkAddress": { "title": "INetworkAddress", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "ICMPV6ObjectListContainer": { "title": "ICMPV6ObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ICMPV6Object" }, "description": "" } } }, "IVlanModel": { "title": "IVlanModel", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "data": { "$ref": "#/components/schemas/IVlanTagLiteral" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "RESTObservableListContainer": { "title": "RESTObservableListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RESTObservable" }, "description": "" } } }, "PolicyAssignment": { "title": "PolicyAssignment", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" }, "type": { "type": "string" }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/ITarget" }, "description": "" }, "version": { "type": "string" }, "policy": { "$ref": "#/components/schemas/IPolicyModel" } } }, "ICMPV4Object": { "title": "ICMPV4Object", "type": "object", "properties": { "icmpType": { "type": "string", "description": "ICMP type number." }, "metadata": { "$ref": "#/components/schemas/PortMetadata" }, "code": { "type": "integer", "description": "ICMP code number.", "format": "int32" }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "name": { "type": "string", "description": "User assigned resource name." }, "description": { "type": "string", "description": "User provided resource description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing response object." }, "type": { "type": "string", "description": "Type associated with resource: ICMPV4Object." }, "version": { "type": "string", "description": "Version number of the response object." }, "overrideTargetId": { "type": "string", "description": "Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain)." } }, "description": "An object defining a ICMPv4 Port object definition." }, "LLCollectionTopic": { "title": "LLCollectionTopic", "type": "object", "properties": { "address": { "type": "string" }, "pollIntervalInMinutes": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "contentBindings": { "type": "string" }, "description": { "type": "string" }, "subType": { "type": "string" }, "type": { "type": "string" }, "messageBinding": { "type": "string" }, "protocolBinding": { "type": "string" }, "hashMap": { "$ref": "#/components/schemas/LLHashMap" } } }, "DeviceCopyConfigRequest": { "title": "DeviceCopyConfigRequest", "type": "object", "properties": { "copySharedPolicies": { "type": "boolean", "description": "Boolean value. Copies shared policies from source standalone device or HA to target standalone device based on True or False input" }, "targetDeviceList": { "type": "array", "items": { "$ref": "#/components/schemas/ITarget" }, "description": "Target device list is a standalone device UUID" }, "sourceDevice": { "$ref": "#/components/schemas/ITarget" } }, "description": "Copy configuration operation on device" }, "VpnEndpoint": { "title": "VpnEndpoint", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "extranet": { "type": "boolean" }, "description": { "type": "string" }, "type": { "type": "string" }, "interface": { "$ref": "#/components/schemas/IReference" }, "connectionType": { "type": "string" }, "version": { "type": "string" }, "extranetInfo": { "$ref": "#/components/schemas/IVpnExtranetInfo" }, "protectedNetworks": { "$ref": "#/components/schemas/IVpnProtectedNetwork" }, "nattedInterfaceAddress": { "type": "string" }, "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "peerType": { "type": "string" }, "device": { "$ref": "#/components/schemas/IReference" }, "ipv6InterfaceAddress": { "type": "string" } } }, "IConsoleUser": { "title": "IConsoleUser", "type": "object", "properties": { "name": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" } } }, "RESTIncidentListContainer": { "title": "RESTIncidentListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RESTIncident" }, "description": "" } } }, "DeviceGroup": { "title": "DeviceGroup", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/IBaseDevice" }, "description": "Represents devices included in group." }, "name": { "type": "string", "description": "User assigned resource name." }, "description": { "type": "string", "description": "User provided resource description." }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string", "description": "Unique identifier of response object." }, "type": { "type": "string", "description": "Response object associated with resource: DeviceGroup." }, "version": { "type": "string", "description": "Version number of the response object." } }, "description": "A model representing a DeviceGroup." }, "ApplicationCategory": { "title": "ApplicationCategory", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "ICommentHistory": { "title": "ICommentHistory", "type": "object", "properties": { "date": { "type": "integer", "format": "int32" }, "comment": { "type": "string" }, "user": { "$ref": "#/components/schemas/IConsoleUser" } } }, "AccessPolicy": { "title": "AccessPolicy", "required": [ "defaultAction" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/AccessPolicyMetadata" }, "defaultAction": { "$ref": "#/components/schemas/IAccessPolicyDefaultAction" }, "name": { "type": "string", "description": "User-specified name of the access control policy." }, "description": { "type": "string", "description": "Description of Access Policy" }, "links": { "$ref": "#/components/schemas/Links" }, "rules": { "type": "object", "description": "Object containing a list of rules in the access control policy." }, "id": { "type": "string", "description": "Unique identifier (UUID) representing the access control policy." }, "type": { "type": "string", "description": "Type of the access control policy; this value is always AccessPolicy." }, "version": { "type": "string", "description": "Version number of the response object." } } }, "IKEv2IPsecProposalListContainer": { "title": "IKEv2IPsecProposalListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IKEv2IPsecProposal" }, "description": "" } } }, "RESTObservationData": { "title": "RESTObservationData", "type": "object", "properties": { "actionTaken": { "type": "string" }, "llobservationData": { "$ref": "#/components/schemas/LLObservationData" }, "miscData": { "$ref": "#/components/schemas/LLMiscData" }, "type": { "type": "string" }, "value": { "type": "string" } } }, "ApplicationListContainer": { "title": "ApplicationListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Application" }, "description": "" } } }, "PortObjectGroup": { "title": "PortObjectGroup", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/PortMetadata" }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/IPortObject" }, "description": "Represents port objects in group." }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "name": { "type": "string", "description": "User-specified name of the policy assignment." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." }, "overrideTargetId": { "type": "string", "description": "Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain)." } }, "description": "A model representing port group definition." }, "FQDNObjectListContainer": { "title": "FQDNObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FQDNObject" }, "description": "" } } }, "IEndPointDeviceType": { "title": "IEndPointDeviceType", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "iseId": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "fqName": { "type": "string" }, "version": { "type": "string" } } }, "Device": { "title": "Device", "required": [ "hostName", "license_caps", "regKey" ], "type": "object", "properties": { "hostName": { "type": "string", "description": "Hostname or IP address of the device. If the device is behind NAT, you can leave the host name as blank, and enter the NAT_ID string in the 'Unique NAT ID' text box. Use the same NAT_ID string that you used while configuring FMC on the device." }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "modelId": { "type": "string", "description": "Model ID of the registered device." }, "natID": { "type": "string", "description": "Unique ID for a Network address translation (NAT) device (optional; used for device registration). If the device to be registered and the Firepower Management Center are separated by a NAT device, enter a unique NAT ID." }, "description": { "type": "string", "description": "User-specified description of the registered device." }, "license_caps": { "type": "array", "items": { "type": "string" }, "description": "License capabilities on the managed device." }, "ftdMode": { "$ref": "#/components/schemas/FtdMode1" }, "modelType": { "type": "string", "description": "Model type of the registered device." }, "type": { "type": "string", "description": "Type of the device; this value is always Device." }, "regKey": { "type": "string", "description": "Registration Key that you entered while configuring FMC on the device." }, "keepLocalEvents": { "type": "boolean", "description": "Boolean indicating whether local events are recorded and kept on the device." }, "version": { "type": "string", "description": "Version number of the response object." }, "sw_version": { "type": "string", "description": "Device version" }, "healthStatus": { "type": "string", "description": "Current health status of the device." }, "healthPolicy": { "$ref": "#/components/schemas/IHealthPolicy" }, "name": { "type": "string", "description": "User-specified name of the registered device. (Example: Device 01 - 192.168.0.152.)" }, "links": { "$ref": "#/components/schemas/ILinks" }, "model": { "type": "string", "description": "Model name of the registered device." }, "modelNumber": { "type": "string", "description": "Model number of the registered device." }, "id": { "type": "string", "description": "Unique identifier (UUID) representing the registered device." }, "accessPolicy": { "$ref": "#/components/schemas/IPolicyModel" }, "prohibitPacketTransfer": { "type": "boolean", "description": "Boolean indicating whether to prohibit the registered device from sending packet data with events to the Firepower Management Center (true) or to allow transfer (false). If this field is set to false (the default), the device transfers packets when a certain event is triggered. Not all traffic data is sent; connection events do not include a payload, only connection metadata." }, "deviceGroup": { "$ref": "#/components/schemas/IDeviceGroup" } }, "description": "A model representing a Device." }, "IAuthTypeAndString": { "title": "IAuthTypeAndString", "type": "object", "properties": { "cryptoKeyString": { "type": "string" }, "cryptoEncryptionType": { "$ref": "#/components/schemas/CryptoEncryptionType" } } }, "ITFCPackets": { "title": "ITFCPackets", "type": "object", "properties": { "burstBytes": { "type": "integer", "format": "int32" }, "timeoutSeconds": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "payloadBytes": { "type": "integer", "format": "int32" } } }, "GeoLocationObjectListContainer": { "title": "GeoLocationObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/GeoLocationObject" }, "description": "" } } }, "AnyProtocolPortObjectListContainer": { "title": "AnyProtocolPortObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AnyProtocolPortObject" }, "description": "" } } }, "FTDS2SVpnModel": { "title": "FTDS2SVpnModel", "type": "object", "properties": { "endpoints": { "type": "object", "description": "Contains information for VPN endpoints." }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "description": { "type": "string", "description": "User provided description." }, "type": { "type": "string", "description": "Response object associated with resource." }, "ipsecSettings": { "$ref": "#/components/schemas/IReference" }, "version": { "type": "string", "description": "Version number of the response object." }, "ikeV2Enabled": { "type": "boolean", "description": "Boolean indicating whether the VPN connection is using INternet Key Exchange v2." }, "ikeV1Enabled": { "type": "boolean", "description": "Boolean indicating whether the VPN connection is using INternet Key Exchange v1." }, "topologyType": { "type": "string", "description": "Indicates the type of topolgy used by the VPN." }, "advancedSettings": { "$ref": "#/components/schemas/IReference" }, "name": { "type": "string", "description": "User chosen resource name." }, "links": { "$ref": "#/components/schemas/ILinks" }, "ikeSettings": { "$ref": "#/components/schemas/IReference" }, "id": { "type": "string", "description": "Unique identifier representing resource." } }, "description": "Contains information about the site-to-site VPN settings used by the Firepower Threat Defense device." }, "FTDAutoNatRule": { "title": "FTDAutoNatRule", "required": [ "natType", "translatedNetwork", "originalNetwork" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "fallThrough": { "type": "boolean" }, "natType": { "$ref": "#/components/schemas/NatType" }, "serviceProtocol": { "$ref": "#/components/schemas/ServiceProtocol" }, "dns": { "type": "boolean" }, "description": { "type": "string" }, "section": { "type": "string" }, "type": { "type": "string" }, "patOptions": { "$ref": "#/components/schemas/IPatOptionsContainer" }, "version": { "type": "string" }, "noProxyArp": { "type": "boolean" }, "translatedNetwork": { "$ref": "#/components/schemas/INetworkAddress" }, "sourceInterface": { "$ref": "#/components/schemas/IInterfaceObjectModel" }, "interfaceInTranslatedNetwork": { "type": "boolean" }, "routeLookup": { "type": "boolean" }, "name": { "type": "string" }, "translatedPort": { "type": "integer", "format": "int32" }, "netToNet": { "type": "boolean" }, "links": { "$ref": "#/components/schemas/ILinks" }, "destinationInterface": { "$ref": "#/components/schemas/IInterfaceObjectModel" }, "id": { "type": "string" }, "originalNetwork": { "$ref": "#/components/schemas/INetworkObjectsOnly" }, "interfaceIpv6": { "type": "boolean" }, "originalPort": { "type": "integer", "format": "int32" } } }, "ApplicationTagListContainer": { "title": "ApplicationTagListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationTag" }, "description": "" } } }, "PolicyAssignmentListContainer": { "title": "PolicyAssignmentListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyAssignment" }, "description": "" } } }, "NetworkObjectListContainer": { "title": "NetworkObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkObject" }, "description": "" } } }, "LLTags": { "title": "LLTags", "type": "object", "properties": { "additionalProperties": { "type": "string" } } }, "IVlanBase": { "title": "IVlanBase", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "overridable": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "HostObjectListContainer": { "title": "HostObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/HostObject" }, "description": "" } } }, "ILifeTime": { "title": "ILifeTime", "type": "object", "properties": { "endLifeTimeValue": { "type": "string" }, "startLifeTimeValue": { "type": "string" }, "timeZone": { "type": "string" }, "endLifetimeType": { "$ref": "#/components/schemas/EndLifetimeType" } } }, "ApplicationTag": { "title": "ApplicationTag", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "ISESecurityGroupTag": { "title": "ISESecurityGroupTag", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "tag": { "type": "integer", "format": "int32" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "IApplicationTag": { "title": "IApplicationTag", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "NetworkOverride": { "title": "NetworkOverride", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Always returns false for overrides." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique UUID representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." } }, "description": "A model representing Network Override object definition." }, "IURLCategory": { "title": "IURLCategory", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "overridable": { "type": "boolean" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "InterfaceEventListContainer": { "title": "InterfaceEventListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/InterfaceEvent" }, "description": "" } } }, "VlanOverrideListContainer": { "title": "VlanOverrideListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VlanOverride" }, "description": "" } } }, "NetworkAddressListContainer": { "title": "NetworkAddressListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkAddress" }, "description": "" } } }, "IIntrusionPolicyModel": { "title": "IIntrusionPolicyModel", "type": "object", "properties": { "inlineDrop": { "type": "integer", "format": "int32" }, "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "basePolicy": { "type": "object" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/ILinks" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "PrefilterPolicyListContainer": { "title": "PrefilterPolicyListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PrefilterPolicy" }, "description": "" } } }, "InlineSetListContainer": { "title": "InlineSetListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/InlineSet" }, "description": "" } } }, "FPLogicalInterfaceListContainer": { "title": "FPLogicalInterfaceListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FPLogicalInterface" }, "description": "" } } }, "VlanTagGroupOverride": { "title": "VlanTagGroupOverride", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Always returns flase for overrides." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." } }, "description": "A model representing tag group override definition." }, "IBasePortLiteral": { "title": "IBasePortLiteral", "type": "object", "properties": { "protocol": { "type": "string" }, "type": { "type": "string" } } }, "RangeObject": { "title": "RangeObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "name": { "type": "string", "description": "User chosen resource name." }, "description": { "type": "string", "description": "User provided description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "The unique type of this object." }, "value": { "type": "string", "description": "Actual value of range." }, "version": { "type": "string", "description": "Version number of the response object." }, "overrideTargetId": { "type": "string", "description": "Unique identifier of domain or device when override assigned to child domain. Used as path query parameter to GET override details for a specific object on a specific target (device or domain)." } }, "description": "A model representing Range Network object definition." }, "VpnIkeSettingsListContainer": { "title": "VpnIkeSettingsListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VpnIkeSettings" }, "description": "" } } }, "SyslogConfig": { "title": "SyslogConfig", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/IMetadata" }, "name": { "type": "string" }, "description": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "id": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } } }, "Ikev2PolicyObjectListContainer": { "title": "Ikev2PolicyObjectListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Ikev2PolicyObject" }, "description": "" } } }, "SIURLListListContainer": { "title": "SIURLListListContainer", "type": "object", "properties": { "links": { "$ref": "#/components/schemas/ILinks" }, "paging": { "$ref": "#/components/schemas/PagingContainer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SIURLList" }, "description": "" } } }, "Links": { "title": "Links", "type": "object", "properties": { "parent": { "type": "string" }, "self": { "type": "string" } } }, "URLGroupObject": { "title": "URLGroupObject", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/IUrlModel" }, "description": "Represents URL objects in group." }, "literals": { "type": "array", "items": { "$ref": "#/components/schemas/IUrlLiteral" }, "description": "Represents target URL associated with URL object." }, "overridable": { "type": "boolean", "description": "Boolean indicating whether object values can be overridden." }, "name": { "type": "string", "description": "User assigned resource name." }, "description": { "type": "string", "description": "User provided resource description." }, "links": { "$ref": "#/components/schemas/Links" }, "overrides": { "$ref": "#/components/schemas/IOverride" }, "id": { "type": "string", "description": "Unique identifier representing resource." }, "type": { "type": "string", "description": "Type associated with resource." }, "version": { "type": "string", "description": "Version number of the response object." }, "overrideTargetId": { "type": "string", "description": "Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain)." } }, "description": "A model representing URL group definition." }, "Action": { "title": "Action", "enum": [ "BLOCK", "TRUST", "PERMIT", "NETWORK_DISCOVERY" ], "type": "string", "description": "Specifies the action to take when the conditions defined by the rule are met. One of: BLOCK | TRUST | NETWORK_DISCOVERY | PERMIT." }, "Action1": { "title": "Action1", "enum": [ "ALLOW", "TRUST", "BLOCK", "MONITOR", "BLOCK_RESET", "BLOCK_INTERACTIVE", "BLOCK_RESET_INTERACTIVE" ], "type": "string" }, "Action2": { "title": "Action2", "enum": [ "ALLOW", "TRUST", "BLOCK", "MONITOR", "BLOCK_RESET", "BLOCK_INTERACTIVE", "BLOCK_RESET_INTERACTIVE" ], "type": "string", "description": "Specifies the action to take when the conditions defined by the rule are met. One of: BLOCK | TRUST | NETWORK_DISCOVERY | PERMIT." }, "Action3": { "title": "Action3", "enum": [ "SWITCH", "HABREAK" ], "type": "string", "description": "FTD HA PUT operation action. Specifically used for breaking FTD HA or manual switch." }, "Action4": { "title": "Action4", "enum": [ "BLOCK", "TRUST", "PERMIT", "NETWORK_DISCOVERY" ], "type": "string" }, "Action5": { "title": "Action5", "enum": [ "SYNC_WITH_DEVICE", "ACCEPT_CHANGES" ], "type": "string" }, "ActionForNonSupportedEngines": { "title": "ActionForNonSupportedEngines", "enum": [ "ALLOW", "BLOCK", "BLOCK_WITH_RESET" ], "type": "string" }, "AuthenticationType": { "title": "AuthenticationType", "enum": [ "MANUAL_PRE_SHARED_KEY", "AUTOMATIC_PRE_SHARED_KEY", "CERTIFICATE" ], "type": "string", "description": "Type of authentication used for the VPN." }, "Category": { "title": "Category", "enum": [ "FRAMEWORK", "OTHER" ], "type": "string" }, "CookieChallenge": { "title": "CookieChallenge", "enum": [ "CUSTOM", "ALWAYS", "NEVER" ], "type": "string" }, "CryptoEncryptionType": { "title": "CryptoEncryptionType", "enum": [ "PLAINTEXT" ], "type": "string" }, "CryptoMapType": { "title": "CryptoMapType", "enum": [ "STATIC", "DYNAMIC" ], "type": "string" }, "DnsResolution": { "title": "DnsResolution", "enum": [ "IPV4_ONLY", "IPV6_ONLY", "IPV4_AND_IPV6" ], "type": "string" }, "DoNotFragmentPolicy": { "title": "DoNotFragmentPolicy", "enum": [ "SET", "COPY", "CLEAR", "NONE" ], "type": "string" }, "Duplex": { "title": "Duplex", "enum": [ "AUTO", "FULL", "HALF" ], "type": "string" }, "EncKeyGenerationScheme": { "title": "EncKeyGenerationScheme", "enum": [ "AUTO", "CUSTOM" ], "type": "string" }, "EndLifetimeType": { "title": "EndLifetimeType", "enum": [ "INFINITE", "DURATION", "DATETIME" ], "type": "string" }, "FileAndMalwareSyslogSeverity": { "title": "FileAndMalwareSyslogSeverity", "enum": [ "ALERT", "CRIT", "DEBUG", "EMERG", "ERR", "INFO", "NOTICE", "WARNING" ], "type": "string" }, "FtdMode": { "title": "FtdMode", "enum": [ "ROUTED", "TRANSPARENT" ], "type": "string" }, "FtdMode1": { "title": "FtdMode1", "enum": [ "ROUTED", "TRANSPARENT" ], "type": "string", "description": "FTD mode (Example: ROUTED or TRANSPARENT)" }, "IdentitySentToPeer": { "title": "IdentitySentToPeer", "enum": [ "IP_ADDRESS", "HOST_NAME", "AUTO_OR_DN" ], "type": "string" }, "IkeKeepalive": { "title": "IkeKeepalive", "enum": [ "DISABLED", "ENABLED", "ENABLED_INFINITE" ], "type": "string" }, "IkeV2Mode": { "title": "IkeV2Mode", "enum": [ "TUNNEL", "TRANSPORT_PREFERRED", "TRANSPORT_REQUIRE" ], "type": "string" }, "InterfaceMode": { "title": "InterfaceMode", "enum": [ "PASSIVE", "INLINE", "SWITCHED", "ROUTED", "ASA" ], "type": "string" }, "InterfaceMode2": { "title": "InterfaceMode2", "enum": [ "PASSIVE", "INLINE", "SWITCHED", "ROUTED" ], "type": "string" }, "InterfacePollTimeUnit": { "title": "InterfacePollTimeUnit", "enum": [ "SEC", "MSEC" ], "type": "string" }, "InterfaceType": { "title": "InterfaceType", "enum": [ "NONE", "MANAGEMENT", "PASSIVE", "INLINE", "SWITCHED", "ROUTED", "HA_LINK", "ASA" ], "type": "string" }, "InterfaceType2": { "title": "InterfaceType2", "enum": [ "SWITCHED", "ROUTED", "VLAN" ], "type": "string" }, "LacpMode": { "title": "LacpMode", "enum": [ "ACTIVE", "PASSIVE", "ON" ], "type": "string" }, "LoadBalancing": { "title": "LoadBalancing", "enum": [ "DST_IP", "DST_IP_PORT", "DST_PORT", "DST_MAC", "SRC_IP", "SRC_IP_PORT", "SRC_PORT", "SRC_MAC", "SRC_DST_IP", "SRC_DST_IP_PORT", "SRC_DST_PORT", "SRC_DST_MAC", "VLAN_DST_IP", "VLAN_DST_IP_PORT", "VLAN_SRC_IP", "VLAN_SRC_IP_PORT", "VLAN_SRC_DST_IP", "VLAN_SRC_DST_IP_PORT", "VLAN_ONLY" ], "type": "string" }, "MessageKey": { "title": "MessageKey", "enum": [ "DEPLOYING", "NOTCLUSTERED" ], "type": "string" }, "Mode": { "title": "Mode", "enum": [ "INLINE", "PASSIVE", "TAP", "ERSPAN", "NONE" ], "type": "string" }, "NatType": { "title": "NatType", "enum": [ "STATIC", "DYNAMIC" ], "type": "string" }, "PeerHoldTimeUnit": { "title": "PeerHoldTimeUnit", "enum": [ "SEC", "MSEC" ], "type": "string" }, "PeerIdentityValidation": { "title": "PeerIdentityValidation", "enum": [ "DO_NOT_CHECK", "REQUIRED", "IF_SUPPORTED_BY_CERT" ], "type": "string" }, "PeerPollTimeUnit": { "title": "PeerPollTimeUnit", "enum": [ "SEC", "MSEC" ], "type": "string" }, "PppAuth": { "title": "PppAuth", "enum": [ "PAP", "CHAP", "MSCHAP" ], "type": "string" }, "Reason": { "title": "Reason", "enum": [ "RBAC", "SYSTEM", "DOMAIN" ], "type": "string", "description": "Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain)." }, "Reason1": { "title": "Reason1", "enum": [ "RBAC", "SYSTEM", "DOMAIN" ], "type": "string" }, "Reputation": { "title": "Reputation", "enum": [ "HIGH_RISK", "SUSPICIOUS_SITES", "BENIGN_SITES_WITH_SECURITY_RISKS", "BENIGN_SITES", "WELL_KNOWN" ], "type": "string" }, "ServiceProtocol": { "title": "ServiceProtocol", "enum": [ "TCP", "UDP" ], "type": "string" }, "Severity": { "title": "Severity", "enum": [ "ERROR", "WARN" ], "type": "string" }, "SeverityForPlatformSettingSyslogConfig": { "title": "SeverityForPlatformSettingSyslogConfig", "enum": [ "ALERT", "CRIT", "DEBUG", "EMERG", "ERR", "INFO", "NOTICE", "WARNING" ], "type": "string" }, "Speed": { "title": "Speed", "enum": [ "AUTO", "TEN", "HUNDRED", "THOUSAND", "TEN_THOUSAND", "FORTY_THOUSAND", "LAKH" ], "type": "string" }, "State": { "title": "State", "enum": [ "DISASSOCIATED", "ASSOCIATED", "MODIFIED" ], "type": "string" }, "SyslogSeverity": { "title": "SyslogSeverity", "enum": [ "ALERT", "CRIT", "DEBUG", "EMERG", "ERR", "INFO", "NOTICE", "WARNING" ], "type": "string" }, "SyslogSeverity1": { "title": "SyslogSeverity1", "enum": [ "ALERT", "CRIT", "DEBUG", "EMERG", "ERR", "INFO", "NOTICE", "WARNING" ], "type": "string", "description": "Specifies the Override Severity if alerts are being sent to default syslog configuration. One of: ALERT | CRIT | DEBUG | EMERG | ERR | INFO | NOTICE | WARNING." }, "TaskType": { "title": "TaskType", "enum": [ "DEVICE_REGISTRATION", "DEVICE_DEPLOYMENT", "NGFWHA_OPERATIONS", "COPY_CONFIG_REQUEST", "HIT_COUNT_REFRESH" ], "type": "string" }, "TrafficInterruption": { "title": "TrafficInterruption", "enum": [ "YES", "NO", "UNDETERMINED", "ERROR" ], "type": "string" } } }, "tags": [ { "name": "Devices" }, { "name": "Policy Assignments" }, { "name": "Device HA Pairs" }, { "name": "Updates" }, { "name": "Intelligence" }, { "name": "Audit" }, { "name": "Device Groups" }, { "name": "Integration" }, { "name": "Status" }, { "name": "Device Clusters" }, { "name": "System Information" }, { "name": "Policy" }, { "name": "Object" }, { "name": "Deployment" } ] }