openapi: 3.2.0
info:
title: Cisco Secure Firewall Object API
version: 1.13.0
contact:
name: Cisco Firepower TAC
email: ngfw-support@cisco.com
description: 'Operations tagged Object across 2 of this provider''s published API definitions: cdfmc-openapi.yaml, cisco-secure-firewall-cdfmc-openapi.yml.
Each path carries the servers of the definition it was published in.'
x-provenance:
method: harvested
first_party: true
harvested: '2026-08-19'
source: https://raw.githubusercontent.com/CiscoDevNet/scc-public-api-docs/main/cdo/cdfmc-openapi.yaml
source_repo: https://github.com/CiscoDevNet/scc-public-api-docs
note: Verbatim first-party OpenAPI published by Cisco in the CiscoDevNet scc-public-api-docs repository, the source of
record for developer.cisco.com/docs/cisco-security-cloud-control-firewall-manager/. Not authored or modified by API
Evangelist.
derived_view: Per-tag view of cisco-secure-firewall-cdfmc-openapi.yml, the provider's source document. Operations and
schemas are the provider's, unmodified; only the partition is ours.
derived_from: cisco-secure-firewall-cdfmc-openapi.yml
operation_coverage: 508/508
x-evidence:
fetched: '2026-08-19'
url: https://raw.githubusercontent.com/CiscoDevNet/scc-public-api-docs/main/cdo/cdfmc-openapi.yaml
http_status: 200
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
tags:
- name: Object
paths:
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes:
get:
deprecated: false
description: '**Get the list of all AnyConnect Custom Attribute objects.**'
operationId: getAllAnyConnectCustomAttributeModel
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/anyconnectcustomattributes?limit=1 ( Get all paginated
anyconnect custom attribute objects with limit=1 )'
: value:
items:
- attributeType: ALLOW_DEFER_UPDATE
id: 00505681-5111-0ed3-0000-008589934595
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes
name: custAttr1
type: AnyConnectCustomAttribute
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/anyconnectcustomattributes?offset=0&limit=25&expanded=true
( Get all paginated anyconnect custom attribute objects with expanded=true )'
: value:
items:
- attributeType: PER_APP_VPN
description: Per App VPN
id: 00505681-5111-0ed3-0000-012884901891
links:
self: https://u35c01p01-vrouter.cisco.com:10421/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/anyconnectcustomattributes/00505681-5111-0ed3-0000-012884901891
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: ma
timestamp: 1649698834000.0
name: custAttr2
overridable: false
perAppVpnBase64EncodedValue: dGVzdA==
type: AnyConnectCustomAttribute
- attributeType: DYNAMIC_SPLIT_TUNNELING
description: Dynamic Split Tunneling
dynamicSplitTunnel:
excludeDomains:
- cisco3.com
- cisco4.com
includeDomains:
- cisco1.com
- cisco2.com
id: 00505681-5111-0ed3-0000-012884901909
links:
self: https://u35c01p01-vrouter.cisco.com:10421/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/anyconnectcustomattributes/00505681-5111-0ed3-0000-012884901909
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: ma
timestamp: 1649698904000.0
name: custAttr3
overridable: false
type: AnyConnectCustomAttribute
- attributeType: ALLOW_DEFER_UPDATE
deferUpdate:
defaultAction: DEFER
minimumAnyConnectVersion: 7.2.0
promptType: NO_PROMPT_AUTO_ACTION
description: ' Post from rest'
id: 00505681-6B90-0ed3-0000-021474836509
links:
self: https://u35c01p01-vrouter.cisco.com:10421/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/anyconnectcustomattributes/00505681-6B90-0ed3-0000-021474836509
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: ma
timestamp: 0
name: custAttr2
overridable: false
type: AnyConnectCustomAttribute
- attributeType: USER_DEFINED_CUSTOM_ATTR
description: AnyConnect Custom Attribute User Defined in PUT
id: 00505681-5111-0ed3-0000-064424509586
links:
self: https://u35c01p01-vrouter.cisco.com:10421/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/anyconnectcustomattributes/00505681-5111-0ed3-0000-064424509586
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: ma
timestamp: 0
name: custAttr4_put
overridable: false
type: AnyConnectCustomAttribute
userDefinedAttribute:
name: Test_put
value: Cisco_put
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes?offset=0&limit=25&expanded=true
paging:
count: 4
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/AnyConnectCustomAttributeModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an AnyConnect Custom Attribute. _Check the response section for applicable examples (if any)._**'
operationId: createAnyConnectCustomAttributeModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/anyconnectcustomattributes ( POST operation for
anyconnect custom attribute objects )'
: value:
attributeType: DYNAMIC_SPLIT_TUNNELING
description: Dynamic Split Tunneling rest
dynamicSplitTunnel:
excludeDomains:
- cisco3.com
- cisco4.com
includeDomains:
- cisco1.com
- cisco2.com
name: AnyConnectCustAttr_DynamicSplitTunnel1
overridable: false
type: AnyConnectCustomAttribute
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/anyconnectcustomattributes ( POST operation for
anyconnect custom attribute objects )'
: value:
attributeType: ALLOW_DEFER_UPDATE
deferUpdate:
defaultAction: DEFER
minimumAnyConnectVersion: 7.2.0
promptType: NO_PROMPT_AUTO_ACTION
description: ' Post from rest'
name: AnyConnectCustAttr_AllowDeferUpdate1
overridable: false
type: AnyConnectCustomAttribute
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/anyconnectcustomattributes ( POST operation for
anyconnect custom attribute objects )'
: value:
attributeType: USER_DEFINED_CUSTOM_ATTR
description: AnyConnect Custom Attribute User Defined
name: AnyConnectCustAttr_UserDefinedCustomAttr1
overridable: false
type: AnyConnectCustomAttribute
userDefinedAttribute:
name: Test_b1
value: Cisco
? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/anyconnectcustomattributes ( POST operation for
anyconnect custom attribute objects )'
: value:
attributeType: PER_APP_VPN
description: Per App VPN
name: AnyConnectCustAttr_PerAppVpn1
overridable: false
perAppVpnBase64EncodedValue: dGVzdA==
type: AnyConnectCustomAttribute
schema:
$ref: '#/components/schemas/AnyConnectCustomAttributeModel'
type: object
description: Input representation of AnyConnect Custom Attribute object.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/anyconnectcustomattributes ( POST operation for
anyconnect custom attribute objects )'
: value:
attributeType: DYNAMIC_SPLIT_TUNNELING
description: Dynamic Split Tunneling rest
dynamicSplitTunnel:
excludeDomains:
- cisco7.com
- cisco8.com
includeDomains:
- cisco5.com
- cisco6.com
id: 00505681-5111-0ed3-0000-064424509605
links:
self: https://u35c01p01-vrouter.cisco.com:10421/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/anyconnectcustomattributes/00505681-5111-0ed3-0000-064424509605
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: ma
timestamp: 0
name: AnyConnectCustAttr_DynamicSplitTunnel1
overridable: false
type: AnyConnectCustomAttribute
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/anyconnectcustomattributes ( POST operation for
anyconnect custom attribute objects )'
: value:
attributeType: ALLOW_DEFER_UPDATE
deferUpdate:
defaultAction: DEFER
minimumAnyConnectVersion: 7.2.0
promptType: NO_PROMPT_AUTO_ACTION
description: ' Post from rest'
id: 00505681-5111-0ed3-0000-064424509605
links:
self: https://u35c01p01-vrouter.cisco.com:10421/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/anyconnectcustomattributes/00505681-5111-0ed3-0000-064424509605
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: ma
timestamp: 0
name: AnyConnectCustAttr_AllowDeferUpdate1
overridable: false
type: AnyConnectCustomAttribute
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/anyconnectcustomattributes ( POST operation for
anyconnect custom attribute objects )'
: value:
attributeType: USER_DEFINED_CUSTOM_ATTR
description: AnyConnect Custom Attribute User Defined
id: 00505681-5111-0ed3-0000-064424509605
links:
self: https://u35c01p01-vrouter.cisco.com:10421/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/anyconnectcustomattributes/00505681-5111-0ed3-0000-064424509605
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: ma
timestamp: 0
name: AnyConnectCustAttr_UserDefinedCustomAttr1
overridable: false
type: AnyConnectCustomAttribute
userDefinedAttribute:
name: Test_b1
value: Cisco
? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/anyconnectcustomattributes ( POST operation for
anyconnect custom attribute objects )'
: value:
attributeType: PER_APP_VPN
description: Per App VPN
id: 00505681-5111-0ed3-0000-064424509605
links:
self: https://u35c01p01-vrouter.cisco.com:10421/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/anyconnectcustomattributes/00505681-5111-0ed3-0000-064424509605
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: ma
timestamp: 0
name: AnyConnectCustAttr_PerAppVpn1
overridable: false
perAppVpnBase64EncodedValue: dGVzdA==
type: AnyConnectCustomAttribute
schema:
$ref: '#/components/schemas/AnyConnectCustomAttributeModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all (Domain and Device) overrides on a AnyConnect Custom Attribute object. Response will always
be in expanded form. If passed, the "expanded" query parameter will be ignored.**'
operationId: getAnyConnectCustomAttributeOverride
parameters:
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes/{containerUUID}/overrides?offset=0&limit=1
( Get all overrides on given anyconnect custom attribute objects )'
: value:
items:
- anyConnectAttribute: DYNAMIC_SPLIT_TUNNELING
description: CustomAttr-4 desc
id: AnyConnectCustomAttributeUUID
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes/{containerUUID}?overrideTargetId=targetUUID
metadata:
domain:
id: domainUUID
name: Global \ dom2
type: Domain
lastUser:
name: admin
timestamp: number
name: CustomAttr-4
overridable: true
overrides:
parent:
id: AnyConnectCustomAttributeUUID
type: AnyConnectCustomAttribute
target:
id: targetUUID
name: Global \ dom2
type: Domain
type: AnyConnectCustomAttribute
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes/{containerUUID}/overrides?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/AnyConnectCustomAttributeOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes/{objectId}:
delete:
deprecated: false
description: '**Delete the AnyConnect Custom Attribute associated with the specified ID. _Check the response section
for applicable examples (if any)._**'
operationId: deleteAnyConnectCustomAttributeModel
parameters:
- description: Unique identifier of the AnyConnect Custom Attribute.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/anyconnectcustomattributes/objectId ( Delete
anyconnect custom attribute for particuler object ID )'
: value:
attributeType: USER_DEFINED_CUSTOM_ATTR
description: AnyConnect Custom Attribute User Defined in PUT
id: 00505681-5111-0ed3-0000-064424509586
links:
self: https://u35c01p01-vrouter.cisco.com:10421/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/anyconnectcustomattributes/00505681-5111-0ed3-0000-064424509586
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: ma
timestamp: 1650479640000.0
name: custAttr4_put
overridable: false
type: AnyConnectCustomAttribute
userDefinedAttribute:
name: Test_put
value: Cisco_put
schema:
$ref: '#/components/schemas/AnyConnectCustomAttributeModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the AnyConnect Custom Attribute associated with the specified ID.**'
operationId: getAnyConnectCustomAttributeModel
parameters:
- description: Unique identifier of the AnyConnect Custom Attribute.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/anyconnectcustomattributes/objectId ( Get anyconnect
custom attribute for particuler object ID )'
: value:
attributeType: USER_DEFINED_CUSTOM_ATTR
description: AnyConnect Custom Attribute User Defined in PUT
id: 00505681-5111-0ed3-0000-064424509586
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes/{objectId}
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: ma
timestamp: 1650479640000.0
name: custAttr4_put
overridable: false
type: AnyConnectCustomAttribute
userDefinedAttribute:
name: Test_put
value: Cisco_put
schema:
$ref: '#/components/schemas/AnyConnectCustomAttributeModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the AnyConnect Custom Attribute associated with the specified ID. _Check the response section
for applicable examples (if any)._**'
operationId: updateAnyConnectCustomAttributeModel
parameters:
- description: Unique identifier of the AnyConnect Custom Attribute.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AnyConnectCustomAttributeModel'
type: object
description: Input representation of AnyConnect Custom Attribute object.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AnyConnectCustomAttributeModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/anyconnectexternalbrowserpackages:
get:
deprecated: false
description: '**Get list of all AnyConnect External Browser Package objects.**'
operationId: getAllAnyConnectExternalBrowserPackageModel
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/anyconnectexternalbrowserpackages?limit=1 ( Get
all paginated anyconnect package objects with limit=1 )'
: value:
items:
- fileName: BrowserPackage_1.pkg
id: AnyConnectExternalBrowserPackageUUID
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectexternalbrowserpackages
name: AnyConnectExternalBrowserPackage1
type: AnyConnectExternalBrowserPackage
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectexternalbrowserpackages?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/AnyConnectExternalBrowserPackageModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an AnyConnect External Browser Package. _Check the response section for applicable examples (if
any)._**'
operationId: createAnyConnectExternalBrowserPackageModel
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
multipart/form-data:
schema:
properties:
description:
description: Provided resource description.
type: string
name:
description: Provided resource name. *required
type: string
payloadFile:
description: Select a Package file. .pkg, .zip are the supported file format. *required
format: binary
type: string
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AnyConnectExternalBrowserPackageModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/anyconnectexternalbrowserpackages/{objectId}:
delete:
deprecated: false
description: '**Delete the AnyConnect External Browser Package associated with the specified ID. _Check the response
section for applicable examples (if any)._**'
operationId: deleteAnyConnectExternalBrowserPackageModel
parameters:
- description: Unique identifier of the AnyConnect Browser Package.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/anyconnectexternalbrowserpackages/objectId (
DELETE operation for External Browser Package )'
: value:
description: Test211-desc
fileName: external-sso-4.9.0-webdeploy-k9.pkg
id: 00505681-1EBF-0ed3-0000-519691042871
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1636457682943.0
name: Test211
type: AnyConnectExternalBrowserPackage
schema:
$ref: '#/components/schemas/AnyConnectExternalBrowserPackageModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the AnyConnect External Browser Package associated with the specified ID.**'
operationId: getAnyConnectExternalBrowserPackageModel
parameters:
- description: Unique identifier of the AnyConnect Browser Package.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/anyconnectexternalbrowserpackages/objectId ( Get
anyconnect package for particuler object ID )'
: value:
fileName: BrowserPackage_1.pkg
id: AnyConnectExternalBrowserPackageUUID
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectexternalbrowserpackages/{objectId}
metadata:
domain:
id: domainUUID
name: AnyConnectExternalBrowserPackage1
type: AnyConnectExternalBrowserPackage
schema:
$ref: '#/components/schemas/AnyConnectExternalBrowserPackageModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the AnyConnect External Browser Package associated with the specified ID. _Check the response
section for applicable examples (if any)._**'
operationId: updateAnyConnectExternalBrowserPackageModel
parameters:
- description: Unique identifier of the AnyConnect Browser Package.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
multipart/form-data:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/anyconnectexternalbrowserpackages/anyconnectexternalbrowserpackageUUID
( Success: Test PUT method for AnyConnect External Browser Package )'
: value:
description: string
id: string
name: string
payloadFile: .pkg or .zip file
schema:
properties:
description:
description: Provided resource description.
type: string
id:
description: Unique identifier of the AnyConnect Browser Package.
type: string
name:
description: Provided resource name. *required
type: string
payloadFile:
description: Select a Package file. .pkg, .zip are the supported file format. *required
format: binary
type: string
type: object
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/anyconnectexternalbrowserpackages/anyconnectexternalbrowserpackageUUID
( Success: Test PUT method for AnyConnect External Browser Package )'
: value:
description: Test211-desc
fileName: external-sso-4.9.0-webdeploy-k9.pkg
id: 00505681-1EBF-0ed3-0000-519691042871
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1636457682943.0
name: Test211
type: AnyConnectExternalBrowserPackage
schema:
$ref: '#/components/schemas/AnyConnectExternalBrowserPackageModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/anyconnectpackages:
get:
deprecated: false
description: '**Get the list of all AnyConnect Packages.**'
operationId: getAllAnyConnectPackageModel
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/anyconnectpackages?limit=1 ( Get all paginated
anyconnect package objects with limit=1 )'
: value:
items:
- fileName: string
id: string
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectpackages
name: string
type: AnyConnectPackage
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectpackages?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/AnyConnectPackageModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an AnyConnect Package. _Check the response section for applicable examples (if any)._**'
operationId: createAnyConnectPackageModel
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
multipart/form-data:
schema:
properties:
description:
description: Provided resource description.
type: string
name:
description: Provided resource name. *required
type: string
payloadFile:
description: Select a Package file. .pkg is the supported file format. *required
format: binary
type: string
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AnyConnectPackageModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/anyconnectpackages/{objectId}:
delete:
deprecated: false
description: '**Delete the AnyConnect Package associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteAnyConnectPackageModel
parameters:
- description: Unique identifier of the AnyConnect Package.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/anyconnectpackages/objectId ( DELETE operation
for anyconnect package )'
: value:
description: desc
fileName: anyconnect-win-4.5.03040-webdeploy-k9.pkg
id: 00505681-1EBF-0ed3-0000-489626271834
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1635851000923.0
name: abc
type: AnyConnectPackage
schema:
$ref: '#/components/schemas/AnyConnectPackageModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the AnyConnect Package associated with the specified ID.**'
operationId: getAnyConnectPackageModel
parameters:
- description: Unique identifier of the AnyConnect Package.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/anyconnectpackages/objectId ( Get anyconnect package
for particuler object ID )'
: value:
fileName: string
id: string
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectpackages/{objectId}
metadata:
domain:
id: string
name: string
type: AnyConnectPackage
schema:
$ref: '#/components/schemas/AnyConnectPackageModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the AnyConnect Package associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateAnyConnectPackageModel
parameters:
- description: Unique identifier of the AnyConnect Package.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
multipart/form-data:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/anyconnectpackages/anyconnectpackageUUID ( Success:
Test PUT method for anyconnect package )'
: value:
description: string
id: string
name: string
payloadFile: .pkg file
schema:
properties:
description:
description: Provided resource description.
type: string
id:
description: Unique identifier of the AnyConnect Package.
type: string
name:
description: Provided resource name. *required
type: string
payloadFile:
description: Select a Package file. .pkg is the supported file format. *required
format: binary
type: string
type: object
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/anyconnectpackages/anyconnectpackageUUID ( Success:
Test PUT method for anyconnect package )'
: value:
description: desc
fileName: anyconnect-win-4.5.03040-webdeploy-k9.pkg
id: 00505681-1EBF-0ed3-0000-489626271834
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1635851000923.0
name: abc
type: AnyConnectPackage
schema:
$ref: '#/components/schemas/AnyConnectPackageModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/anyconnectprofiles:
get:
deprecated: false
description: '**Get the list of all AnyConnect Profiles.**'
operationId: getAllAnyConnectProfileModel
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/anyconnectprofiles?limit=1 ( Get all paginated
anyconnect profile objects with limit=1 )'
: value:
items:
- fileName: string
fileType: string
id: string
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectprofiles/{objectId}
name: string
type: AnyConnectProfile
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectprofiles?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/AnyConnectProfileModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an AnyConnect Profile. _Check the response section for applicable examples (if any)._**'
operationId: createAnyConnectProfileModel
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
multipart/form-data:
schema:
properties:
description:
description: Provided resource description.
type: string
fileType:
description: Provided resource file type. *required. [ ANYCONNECT_MANAGEMENT_VPN_PROFILE, AMP_ENABLER,
FEEDBACK, WEB_SECURITY, ANYCONNECT_VPN_PROFILE, UMBRELLA_ROAMING, NETWORK_ACCESS_MANAGER, ISE_POSTURE,
NETWORK_VISIBILITY ].
type: string
name:
description: Provided resource name. *required
type: string
payloadFile:
description: Select a file. .xml, .asp, .fsp, .isp, .nsp, .nvmsp, .json, .wsp, .wso are the
supported file format. *required
format: binary
type: string
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AnyConnectProfileModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/anyconnectprofiles/{objectId}:
delete:
deprecated: false
description: '**Delete the AnyConnect Profile associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteAnyConnectProfileModel
parameters:
- description: Unique identifier of the AnyConnect Profile.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/anyconnectprofiles/objectId ( DELETE operation
for anyconnect profile )'
: value:
description: Test-331-desc
fileName: acvpn_profile-1.xml
fileType: ANYCONNECT_VPN_PROFILE
id: 00505681-1EBF-0ed3-0000-528280977498
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1636461364733.0
name: Test-331
type: AnyConnectProfile
schema:
$ref: '#/components/schemas/AnyConnectProfileModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the AnyConnect Profile associated with the specified ID.**'
operationId: getAnyConnectProfileModel
parameters:
- description: Unique identifier of the AnyConnect Profile.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/anyconnectprofiles/objectId ( Get anyconnect profile
for particuler object ID )'
: value:
fileName: string
fileType: string
id: string
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/anyconnectprofiles/{objectId}
metadata:
domain:
id: string
name: string
type: AnyConnectProfile
schema:
$ref: '#/components/schemas/AnyConnectProfileModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the AnyConnect Profile associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateAnyConnectProfileModel
parameters:
- description: Unique identifier of the AnyConnect Profile.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
multipart/form-data:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/anyconnectprofiles/anyconnectprofileUUID ( Success:
Test PUT method for anyconnect profile )'
: value:
description: string
fileType: string
id: string
name: string
payloadFile: .xml, .asp, .fsp, .isp, .nsp, .nvmsp, .json, .wsp or .wso file
schema:
properties:
description:
description: Provided resource description.
type: string
fileType:
description: Provided resource file type. *required. [ ANYCONNECT_MANAGEMENT_VPN_PROFILE, AMP_ENABLER,
FEEDBACK, WEB_SECURITY, ANYCONNECT_VPN_PROFILE, UMBRELLA_ROAMING, NETWORK_ACCESS_MANAGER, ISE_POSTURE,
NETWORK_VISIBILITY ].
type: string
id:
description: Unique identifier of the AnyConnect Profile.
type: string
name:
description: Provided resource name. *required
type: string
payloadFile:
description: Select a file. .xml, .asp, .fsp, .isp, .nsp, .nvmsp, .json, .wsp, .wso are the
supported file format. *required
format: binary
type: string
type: object
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/anyconnectprofiles/anyconnectprofileUUID ( Success:
Test PUT method for anyconnect profile )'
: value:
description: Test-331-desc
fileName: acvpn_profile-1.xml
fileType: ANYCONNECT_VPN_PROFILE
id: 00505681-1EBF-0ed3-0000-528280977498
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1636461364733.0
name: Test-331
type: AnyConnectProfile
schema:
$ref: '#/components/schemas/AnyConnectProfileModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/anyprotocolportobjects:
get:
deprecated: false
description: '**Get the list of all protocol port objects (all port objects with a protocol value of All).**'
operationId: getAllAnyProtocolPortObject
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/anyprotocolportobjects ( Success Test GET ALL of
AnyProtocolPort Objects )'
: value:
description: ' '
id: anyProtocolPortObjUUID
links:
parent: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/ports
self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/anyprotocolportobjects/anyProtocolPortObjUUID
name: myAny
type: AnyProtocolPortObject
schema:
$ref: '#/components/schemas/AnyProtocolPortObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/anyprotocolportobjects/{objectId}:
get:
deprecated: false
description: '**Get any protocol port object associated with the specified ID.**'
operationId: getAnyProtocolPortObject
parameters:
- description: Unique identifier of the protocol port object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AnyProtocolPortObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/applicationcategories:
get:
deprecated: false
description: '**Get the list of all application categories.**'
operationId: getAllApplicationCategory
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/applicationcategories?limit=2 ( Get all paginated
ApplicationCategory with limit set 2 )'
: value:
items:
- id: '2325'
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationcategories/2325
name: Low
type: ApplicationCategory
- id: '1234'
links:
self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/applicationcategories/1234
name: Medium
type: ApplicationCategory
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationcategories?offset=0&limit=2
paging:
count: 5
limit: 2
next:
- /fmc_config/v1/domain/domainUUID/object/applicationcategories?offset=2&limit=2
- /fmc_config/v1/domain/domainUUID/object/applicationcategories?offset=4&limit=1
offset: 0
pages: 3
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/applicationcategories?limit=2&expanded=true ( Get
all paginated application with limit set 2 )'
: value:
items:
- id: '1234'
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationcategories/1234
metadata:
count: 1094
name: Very Low 1234
type: ApplicationCategory
- id: '2325'
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationcategories/2325
metadata:
count: 808
name: 050plus
type: ApplicationCategory
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationcategories?offset=0&limit=5
paging:
count: 5
limit: 2
next:
- /fmc_config/v1/domain/domainUUID/object/applicationcategories?offset=2&limit=2
- /fmc_config/v1/domain/domainUUID/object/applicationcategories?offset=4&limit=1
offset: 0
pages: 3
schema:
$ref: '#/components/schemas/ApplicationCategoryListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/applicationcategories/{objectId}:
get:
deprecated: false
description: '**Get the application category with the specified ID.**'
operationId: getApplicationCategory
parameters:
- description: Unique identifier of the application category.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/applicationcategories/2325 ( Get ApplicationCategory by id )':
value:
id: '2325'
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationcategories/2325
metadata:
count: 1094
name: 050plus
type: ApplicationCategory
schema:
$ref: '#/components/schemas/ApplicationCategory'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/applicationfilters:
get:
deprecated: false
description: '**Get the list of all application filters.**'
operationId: getAllApplicationFilter
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/applicationfilters ( Get all paginated ApplicationFilter )':
value:
items:
- id: 907b5452-e4e0-11e5-87ba-df5089dc85eb
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationfilters/907b5452-e4e0-11e5-87ba-df5089dc85eb
name: test1
type: ApplicationFilter
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationfilters?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/applicationfilters?expanded=true ( Get all paginated
application filters )'
: value:
items:
- appConditions:
- productivities:
- id: VERY_LOW
metadata:
count: 218
name: Very Low
type: ApplicationProductivity
risks:
- id: VERY_LOW
name: Very Low
type: ApplicationRisk
search: Risks:Very Low Business Relevance:Very Low
applications:
- appProductivity:
id: VERY_LOW
metadata:
count: 0
name: Very Low
type: ApplicationProductivity
applicationTypes:
- id: WEBAPP
metadata:
count: 0
name: Webapp
type: ApplicationType
decrypted: false
name: 21 Questions
risk:
id: VERY_LOW
name: Very Low
type: ApplicationRisk
type: Application
id: 907b5452-e4e0-11e5-87ba-df5089dc85eb
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationfilters/907b5452-e4e0-11e5-87ba-df5089dc85eb
metadata:
count: 218
name: test1
type: ApplicationFilter
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationfilters?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ApplicationFilterListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an application filter. _Check the response section for applicable examples (if any)._**'
operationId: createApplicationFilter
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationFilter'
type: object
description: The input application filter object model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationFilter'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/applicationfilters/{objectId}:
delete:
deprecated: false
description: '**Delete the application filter associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteApplicationFilter
parameters:
- description: Unique identifier of the application filter.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationFilter'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the application filter associated with the specified ID.**'
operationId: getApplicationFilter
parameters:
- description: Unique identifier of the application filter.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/applicationfilters/907b5452-e4e0-11e5-87ba-df5089dc85eb
( Get Application Filter by id )'
: value:
appConditions:
- productivities:
- id: VERY_LOW
metadata:
count: 218
name: Very Low
type: ApplicationProductivity
risks:
- id: VERY_LOW
name: Very Low
type: ApplicationRisk
search: Risks:Very Low Business Relevance:Very Low
applications:
- appProductivity:
id: VERY_LOW
metadata:
count: 0
name: Very Low
type: ApplicationProductivity
applicationTypes:
- id: WEBAPP
metadata:
count: 0
name: Webapp
type: ApplicationType
decrypted: false
name: 21 Questions
risk:
id: VERY_LOW
name: Very Low
type: ApplicationRisk
type: Application
id: 907b5452-e4e0-11e5-87ba-df5089dc85eb
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationfilters/907b5452-e4e0-11e5-87ba-df5089dc85eb
metadata:
count: 218
name: test1
type: ApplicationFilter
schema:
$ref: '#/components/schemas/ApplicationFilter'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the application filter associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateApplicationFilter
parameters:
- description: Unique identifier of the application filter.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationFilter'
type: object
description: The input application filter object model.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationFilter'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/applicationproductivities:
get:
deprecated: false
description: '**Get the list of all application producticvities.**'
operationId: getAllApplicationProductivity
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/applicationproductivities?limit=2 ( Get all paginated
Application Risk with limit set 2 )'
: value:
items:
- id: LOW
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationproductivities/LOW
name: Low
type: ApplicationProductivity
- id: MEDIUM
links:
self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/applicationproductivities/MEDIUM
name: Medium
type: ApplicationProductivity
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationproductivities?offset=0&limit=2
paging:
count: 5
limit: 2
next:
- /fmc_config/v1/domain/domainUUID/object/applicationproductivities?offset=2&limit=2
- /fmc_config/v1/domain/domainUUID/object/applicationproductivities?offset=4&limit=1
offset: 0
pages: 3
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/applicationproductivities?limit=2&expanded=true
( Get all paginated application risk with limit set 2 )'
: value:
items:
- id: VERY_LOW
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationproductivities/VERY_LOW
metadata:
count: 1094
name: Very Low
type: ApplicationProductivity
- id: LOW
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationproductivities/LOW
metadata:
count: 808
name: Low
type: ApplicationProductivity
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationproductivities?offset=0&limit=5
paging:
count: 5
limit: 2
next:
- /fmc_config/v1/domain/domainUUID/object/applicationproductivities?offset=2&limit=2
- /fmc_config/v1/domain/domainUUID/object/applicationproductivities?offset=4&limit=1
offset: 0
pages: 3
schema:
$ref: '#/components/schemas/ApplicationProductivityListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/applicationproductivities/{objectId}:
get:
deprecated: false
description: '**Get the application productivity with the specified ID.**'
operationId: getApplicationProductivity
parameters:
- description: Unique identifier of the application productivity.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/applicationproductivities/VERY_LOW ( Get country object by id )':
value:
id: VERY_LOW
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationproductivities/VERY_LOW
metadata:
count: 1094
name: Very Low
type: ApplicationProductivity
schema:
$ref: '#/components/schemas/ApplicationProductivity'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/applicationrisks:
get:
deprecated: false
description: '**Get the list of all application risks.**'
operationId: getAllApplicationRisk
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/applicationrisks?limit=2 ( Get all paginated Application
Risk with limit set 2 )'
: value:
items:
- id: LOW
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationrisks/LOW
name: Low
type: ApplicationRisk
- id: MEDIUM
links:
self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/applicationrisks/MEDIUM
name: Medium
type: ApplicationRisk
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationrisks?offset=0&limit=2
paging:
count: 5
limit: 2
next:
- /fmc_config/v1/domain/domainUUID/object/applicationrisks?offset=2&limit=2
- /fmc_config/v1/domain/domainUUID/object/applicationrisks?offset=4&limit=1
offset: 0
pages: 3
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/applicationrisks?limit=2&expanded=true ( Get all
paginated application risk with limit set 2 )'
: value:
items:
- id: VERY_LOW
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationrisks/VERY_LOW
metadata:
count: 1094
name: Very Low
type: ApplicationRisk
- id: LOW
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationrisks/LOW
metadata:
count: 808
name: Low
type: ApplicationRisk
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationrisks?offset=0&limit=5
paging:
count: 5
limit: 2
next:
- /fmc_config/v1/domain/domainUUID/object/applicationrisks?offset=2&limit=2
- /fmc_config/v1/domain/domainUUID/object/applicationrisks?offset=4&limit=1
offset: 0
pages: 3
schema:
$ref: '#/components/schemas/ApplicationRiskListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/applicationrisks/{objectId}:
get:
deprecated: false
description: '**Get the application risk with the specified ID.**'
operationId: getApplicationRisk
parameters:
- description: Unique identifier of the application risk.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/applicationrisks/VERY_LOW ( Get country object by id )':
value:
id: VERY_LOW
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationrisks/VERY_LOW
metadata:
count: 1094
name: Very Low
type: ApplicationRisk
schema:
$ref: '#/components/schemas/ApplicationRisk'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/applications:
get:
deprecated: false
description: '**Get the list of all applications.**'
operationId: getAllApplication
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/applications?limit=2 ( Get all paginated Application
with limit set 2 )'
: value:
items:
- id: '2325'
links:
self: /fmc_config/v1/domain/domainUUID/object/applications/2325
name: Low
type: Application
- id: '1234'
links:
self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/applications/1234
name: Medium
type: Application
links:
self: /fmc_config/v1/domain/domainUUID/object/applications?offset=0&limit=2
paging:
count: 5
limit: 2
next:
- /fmc_config/v1/domain/domainUUID/object/applications?offset=2&limit=2
- /fmc_config/v1/domain/domainUUID/object/applications?offset=4&limit=1
offset: 0
pages: 3
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/applications?limit=2&expanded=true ( Get all paginated
application with limit set 2 )'
: value:
items:
- id: '1234'
links:
self: /fmc_config/v1/domain/domainUUID/object/applications/1234
metadata:
count: 1094
name: Very Low 1234
type: Application
- id: '2325'
links:
self: /fmc_config/v1/domain/domainUUID/object/applications/2325
metadata:
count: 808
name: 050plus
type: Application
links:
self: /fmc_config/v1/domain/domainUUID/object/applications?offset=0&limit=5
paging:
count: 5
limit: 2
next:
- /fmc_config/v1/domain/domainUUID/object/applications?offset=2&limit=2
- /fmc_config/v1/domain/domainUUID/object/applications?offset=4&limit=1
offset: 0
pages: 3
schema:
$ref: '#/components/schemas/ApplicationListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/applications/{objectId}:
get:
deprecated: false
description: '**Get the application with the specified ID.**'
operationId: getApplication
parameters:
- description: Unique identifier of the application.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/applications/2325 ( Get Application by id )':
value:
id: '2325'
links:
self: /fmc_config/v1/domain/domainUUID/object/applications/2325
metadata:
count: 1094
name: 050plus
type: Application
schema:
$ref: '#/components/schemas/Application'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/applicationtags:
get:
deprecated: false
description: '**Get the list of all application tags.**'
operationId: getAllApplicationTag
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/applicationtags?limit=2 ( Get all paginated ApplicationTag
with limit set 2 )'
: value:
items:
- id: '2325'
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationtags/2325
name: Low
type: ApplicationTag
- id: '1234'
links:
self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/applicationtags/1234
name: Medium
type: ApplicationTag
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationtags?offset=0&limit=2
paging:
count: 5
limit: 2
next:
- /fmc_config/v1/domain/domainUUID/object/applicationtags?offset=2&limit=2
- /fmc_config/v1/domain/domainUUID/object/applicationtags?offset=4&limit=1
offset: 0
pages: 3
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/applicationtags?limit=2&expanded=true ( Get all
paginated application with limit set 2 )'
: value:
items:
- id: '1234'
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationtags/1234
metadata:
count: 1094
name: Very Low 1234
type: ApplicationTag
- id: '2325'
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationtags/2325
metadata:
count: 808
name: 050plus
type: ApplicationTag
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationtags?offset=0&limit=5
paging:
count: 5
limit: 2
next:
- /fmc_config/v1/domain/domainUUID/object/applicationtags?offset=2&limit=2
- /fmc_config/v1/domain/domainUUID/object/applicationtags?offset=4&limit=1
offset: 0
pages: 3
schema:
$ref: '#/components/schemas/ApplicationTagListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/applicationtags/{objectId}:
get:
deprecated: false
description: '**Get the application tag with the specified ID.**'
operationId: getApplicationTag
parameters:
- description: Unique identifier of the application tag.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/applicationtags/2325 ( Get ApplicationTag by id )':
value:
id: '2325'
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationtags/2325
metadata:
count: 1094
name: tag1
type: ApplicationTag
schema:
$ref: '#/components/schemas/ApplicationTag'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/applicationtypes:
get:
deprecated: false
description: '**Get the list of all application types.**'
operationId: getAllApplicationType
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/applicationtypes?limit=2 ( Get all paginated ApplicationType
with limit set 2 )'
: value:
items:
- id: '2325'
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationtypes/2325
name: Low
type: ApplicationType
- id: '1234'
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationtypes/1234
name: Medium
type: ApplicationType
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationtypes?offset=0&limit=2
paging:
count: 5
limit: 2
next:
- /fmc_config/v1/domain/domainUUID/object/applicationtypes?offset=2&limit=2
- /fmc_config/v1/domain/domainUUID/object/applicationtypes?offset=4&limit=1
offset: 0
pages: 3
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/applicationtypes?limit=2&expanded=true ( Get all
paginated application with limit set 2 )'
: value:
items:
- id: '1234'
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationtypes/1234
metadata:
count: 1094
name: Very Low 1234
type: ApplicationType
- id: '2325'
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationtypes/2325
metadata:
count: 808
name: 050plus
type: ApplicationType
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationtypes?offset=0&limit=5
paging:
count: 5
limit: 2
next:
- /fmc_config/v1/domain/domainUUID/object/applicationtypes?offset=2&limit=2
- /fmc_config/v1/domain/domainUUID/object/applicationtypes?offset=4&limit=1
offset: 0
pages: 3
schema:
$ref: '#/components/schemas/ApplicationTypeListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/applicationtypes/{objectId}:
get:
deprecated: false
description: '**Get the application type with the specified ID.**'
operationId: getApplicationType
parameters:
- description: Unique identifier of the application type.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/applicationtypes/2325 ( Get ApplicationType by id )':
value:
id: '2325'
links:
self: /fmc_config/v1/domain/domainUUID/object/applicationtypes/2325
metadata:
count: 1094
name: type1
type: ApplicationType
schema:
$ref: '#/components/schemas/ApplicationType'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/aspathlists:
get:
deprecated: false
description: '**Get the list of all Autonomous System Path lists.**'
operationId: getAllAsPathList
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET null ( Test GET All of AsPathList Objects )':
value:
items:
- entries:
- action: PERMIT
regularExpression: 100*100-14+10
sequence: 1
- action: PERMIT
regularExpression: 11*50/4
sequence: 2
id: aspathlistObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/aspathlists/aspathlistObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1622445145556.0
name: 125
overridable: false
type: ASPathList
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/aspathlists?offset=0&limit=25&expanded=true
paging:
count: 1
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/AsPathListListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an Autonomous System Path list. _Check the response section for applicable examples (if any)._**'
operationId: createAsPathList
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST null ( Test POST of AsPathList Object )':
value:
entries:
- action: PERMIT
regularExpression: -10+50*8
sequence: 1
name: 300
schema:
$ref: '#/components/schemas/AsPathList'
type: object
description: Input representation of Autonomous System Path List object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST null ( Test POST of AsPathList Object )':
value:
entries:
- action: PERMIT
regularExpression: -10+50*8
sequence: 1
id: aspathlistObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/aspathlists/aspathlistObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 0
name: 300
overridable: false
type: ASPathList
schema:
$ref: '#/components/schemas/AsPathList'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/aspathlists/{objectId}:
delete:
deprecated: false
description: '**Delete the Autonomous System Path list associated with the specified ID. _Check the response section
for applicable examples (if any)._**'
operationId: deleteAsPathList
parameters:
- description: Unique identifier of the Autonomous System Path list.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : DELETE null ( Test DELETE of AsPathList Object )':
value:
entries:
- action: PERMIT
regularExpression: -1+2
type: AsPathEntry
id: asPathListObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/DomainUUID/object/aspathlists/asPathListObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: rest
timestamp: 1558341736153.0
name: 12
type: ASPathList
schema:
$ref: '#/components/schemas/AsPathList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the Autonomous System Path list associated with the specified ID.**'
operationId: getAsPathList
parameters:
- description: Unique identifier of the Autonomous System Path list.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET null ( Test GET of AsPathList Object )':
value:
entries:
- action: PERMIT
regularExpression: 123*123/1231 123*123/1231
sequence: 1
- action: PERMIT
regularExpression: 123*123
sequence: 2
id: aspathlistObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/aspathlists/aspathlistObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1622445145556.0
name: 125
overridable: false
type: ASPathList
schema:
$ref: '#/components/schemas/AsPathList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the Autonomous System Path list associated with the specified ID. _Check the response section
for applicable examples (if any)._**'
operationId: updateAsPathList
parameters:
- description: Unique identifier of the Autonomous System Path list.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : PUT null ( Test PUT of AsPathList Object )':
value:
entries:
- action: PERMIT
regularExpression: 100/15+10*200
sequence: 1
id: aspathlistObjectUUID
name: 300
schema:
$ref: '#/components/schemas/AsPathList'
type: object
description: Input representation of Autonomous System Path List object.
required: true
responses:
'200':
content:
application/json:
examples:
'Example 1 : PUT null ( Test PUT of AsPathList Object )':
value:
entries:
- action: PERMIT
regularExpression: 100/15+10*200
sequence: 1
id: aspathlistObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/aspathlists/aspathlistObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 0
name: 300
overridable: false
type: ASPathList
schema:
$ref: '#/components/schemas/AsPathList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/azureadrealms:
get:
deprecated: false
description: '**Get the list of all Azure AD Realms.**'
operationId: getAllAzureADRealm
parameters:
- description: 'Filter by any of the following fields: name, tenantId, clientId.'
in: query
name: filter
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/object/azureadrealms?expanded=true ( Get all paginated
Azure AD Realms )'
: value:
expectStatus: 200
items:
- authSessionTimeout: 1440
clientId: 20354d7a-e4fe-47af-8ff6-187bca92f3f9
clientSecret: '*********'
consumerGroupId: azuread-events-test
description: Azure AD for tmedemo1 domain
enabled: true
eventHubsBroker: azure-ad-events-934j.servicebus.windows.net:9093
eventHubsConnString: Endpoint=sb://azure-ad-events-934j.servicebus.windows.net/;SharedAccessKeyName=testad;SharedAccessKey=Fq6YV/ruwOKFYiPVm6PcJKpU3R7a4OEtlfXC7djc0o4=
eventHubsTopic: test
excludedGroups:
- Group_name1
- EU_*
- '*_test'
id: azuread.1
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/azureadrealms/azuread.1
metadata:
readOnly:
reason: RBAC
state: true
name: tmedemo1.ommicrosoft.com
realmId: 1
tenantId: 8c67caeb-e5f4-4ae0-be47-fbb739939768
type: AzureADRealm
uuid: 9c67ygveb-e8j4-87e0-be47-fbb73hgy6768
version: ee718951-0080-46a1-8535-6eec0e74cd3c
- authSessionTimeout: 1440
clientId: 20354d7a-e4fe-47af-8ff6-187bca92f3f9
clientSecret: '*********'
consumerGroupId: azuread-events-test
description: Azure AD for tmedemo2 domain
enabled: true
eventHubsBroker: azure-ad-events-934j.servicebus.windows.net:9093
eventHubsConnString: Endpoint=sb://azure-ad-events-934j.servicebus.windows.net/;SharedAccessKeyName=testad;SharedAccessKey=Fq6YV/ruwOKFYiPVm6PcJKpU3R7a4OEtlfXC7djc0o4=
eventHubsTopic: test
excludedGroups:
- Group_name1
- EU_*
- '*_test'
id: azuread.2
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/azureadrealms/azuread.2
metadata:
readOnly:
reason: RBAC
state: true
name: tmedemo2.ommicrosoft.com
realmId: 2
tenantId: 8c67caeb-e5f4-4ae0-be47-fbb739939768
type: AzureADRealm
uuid: 9c67ygveb-e8j4-87e0-be47-fkjhbvgchf432
version: 3c1cef6e-af32-4fb8-9b19-a55379de6eff
- authSessionTimeout: 1440
clientId: 20354d7a-e4fe-47af-8ff6-187bca92f3f9
clientSecret: '*********'
consumerGroupId: azuread-events-test
description: Azure AD for tmedemo3 domain
enabled: true
eventHubsBroker: azure-ad-events-934j.servicebus.windows.net:9093
eventHubsConnString: Endpoint=sb://azure-ad-events-934j.servicebus.windows.net/;SharedAccessKeyName=testad;SharedAccessKey=Fq6YV/ruwOKFYiPVm6PcJKpU3R7a4OEtlfXC7djc0o4=
eventHubsTopic: test
excludedGroups:
- Group_name1
- EU_*
- '*_test'
id: azuread.3
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/azureadrealms/azuread.3
metadata:
readOnly:
reason: RBAC
state: true
name: tmedemo3.ommicrosoft.com
realmId: 3
tenantId: 8c67caeb-e5f4-4ae0-be47-fbb739939768
type: AzureADRealm
uuid: 9c67ygveb-e8j4-87e0-be47-bfrds5kjb8
version: 4aa8f900-b867-4f9d-b6a9-abdc783de26d
links:
self: api/fmc_config/v1/domain/DomainUUID/object/azureadrealms?expanded=true&offset=0&limit=3
paging:
count: '3'
limit: '3'
offset: '0'
pages: '1'
schema:
$ref: '#/components/schemas/AzureADRealmListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an Azure AD Realm. _Check the response section for applicable examples (if any)._**'
operationId: createAzureADRealm
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AzureADRealm'
type: object
description: Input representation of an Azure AD Realm
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureADRealm'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/azureadrealms/{objectId}:
delete:
deprecated: false
description: '**Delete the Azure AD Realm associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteAzureADRealm
parameters:
- description: Unique identifier of the Azure AD Realm.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/object/azureadrealms/azureADRealmId ( DELETE method
for Azure AD Realms )'
: value:
authSessionTimeout: 1441
clientId: 20354d7a-e4fe-47af-8ff6-187bca92f3f9
clientSecret: '*********'
consumerGroupId: azuread-events-test
description: Azure AD for tmedemo1-2 domain
enabled: true
eventHubsBroker: azure-ad-events-934j.servicebus.windows.net:9093
eventHubsConnString: Endpoint=sb://azure-ad-events-934j.servicebus.windows.net/;SharedAccessKeyName=testad;SharedAccessKey=Fq6YV/ruwOKFYiPVm6PcJKpU3R7a4OEtlfXC7djc0o4=
eventHubsTopic: test
excludedGroups:
- Group_name1
- EU_*
- '*_test'
id: azuread.2
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/azureadrealms/azuread.1
name: tmedemo2.ommicrosoft.com
realmId: 2
tenantId: 8c67caeb-e5f4-4ae0-be47-fbb739939768
type: AzureADRealm
uuid: 9c67ygveb-e8j4-87e0-be47-fbb73hgy6768
version: 3c1cef6e-af32-4fb8-9b19-a55379de6eff
schema:
$ref: '#/components/schemas/AzureADRealm'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the Azure AD Realm associated with the specified ID.**'
operationId: getAzureADRealm
parameters:
- description: Unique identifier of the Azure AD Realm.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureADRealm'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the Azure AD Realm associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateAzureADRealm
parameters:
- description: Unique identifier of the Azure AD Realm.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AzureADRealm'
type: object
description: Input representation of an Azure AD Realm
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureADRealm'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/azureadrealms/{realmId}/download:
post:
deprecated: false
description: '**Download users and groups of the specific Azure AD Realm. _Check the response section for applicable
examples (if any)._**'
operationId: createDownloadAzureADUsersAndGroups
parameters:
- description: Unique identifier of the Azure AD Realm.
in: path
name: realmId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DownloadAzureADUsersAndGroups'
type: object
description: Empty payload.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DownloadAzureADUsersAndGroups'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/azureadstatuses:
get:
deprecated: false
description: '**Get Azure AD realm statuses.**'
operationId: getAzureADStatus
parameters:
- description: Identifiers of realms whose statuses will be received. The values are separated by commas.
in: query
name: ids
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureADStatusListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/bfdtemplates:
get:
deprecated: false
description: '**Get the list of all Bidirectional Forwarding Detection routing templates.**'
operationId: getAllBFDTemplate
parameters:
- description: To filter BFD templates based on hop type, use hopType:{hopType}. Supported hop types are
Single-Hop and Multi-Hop.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/bfdtemplates ( GET ALL paginated BFDTemplate Objects. )':
value:
items:
- hopType: SINGLE_HOP
id: BFDTemplateUUID1
links:
self: /fmc_config/v1/domain/default/object/bfdtemplates/BFDTemplateUUID1
name: singleHopTemplateAlpha
type: BFDTemplate
- hopType: MULTI_HOP
id: BFDTemplateUUID2
links:
self: /fmc_config/v1/domain/default/object/bfdtemplates/BFDTemplateUUID2
name: multiHopTemplateAlpha
type: BFDTemplate
links:
self: /fmc_config/v1/domain/DomainUUID/object/bfdtemplates?offset=0&limit=25
paging:
count: 2
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/BFDTemplateListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a Bidirectional Forwarding Detection routing template. _Check the response section for applicable
examples (if any)._**'
operationId: createBFDTemplate
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/bfdtemplates ( POST a SINGLE_HOP BFDTemplate object request. )':
value:
authentication:
authKey: Admin@123
authKeyId: 1
authType: MD5
pwdEncryption: UN_ENCRYPTED
echo: ENABLED
hopType: SINGLE_HOP
minReceive: 52
minTransmit: 51
name: singleHopTemplateAlpha
txRxInterval: MILLISECONDS
txRxMultiplier: 5
type: BFDTemplate
'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/bfdtemplates ( POST a MULTI_HOP BFDTemplate object request. )':
value:
authentication:
authKey: Admin@123
authKeyId: 1
authType: MD5
pwdEncryption: UN_ENCRYPTED
hopType: MULTI_HOP
minReceive: 52
minTransmit: 51
name: multiHopTemplateAlpha
txRxInterval: MILLISECONDS
txRxMultiplier: 5
type: BFDTemplate
schema:
$ref: '#/components/schemas/BFDTemplate'
type: object
description: Input representation of Bidirectional Forwarding Detection routing template object.
required: true
responses:
'202':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/bfdtemplates ( POST a SINGLE_HOP BFDTemplate object request. )':
value:
authentication:
authKey: '********'
authKeyId: 1
authType: MD5
pwdEncryption: UN_ENCRYPTED
echo: ENABLED
hopType: SINGLE_HOP
id: BFDTemplateUUID
links:
self: /fmc_config/v1/domain/DomainUUID/object/bfdtemplates/BFDTemplateUUID
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1613995959773.0
minReceive: 52
minTransmit: 51
name: singleHopTemplateAlpha
overridable: false
txRxInterval: MILLISECONDS
txRxMultiplier: 5
type: BFDTemplate
'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/bfdtemplates ( POST a MULTI_HOP BFDTemplate object request. )':
value:
authentication:
authKey: '********'
authKeyId: 1
authType: MD5
pwdEncryption: UN_ENCRYPTED
hopType: MULTI_HOP
id: BFDTemplateUUID
links:
self: /fmc_config/v1/domain/DomainUUID/object/bfdtemplates/BFDTemplateUUID1
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1613995959773.0
minReceive: 52
minTransmit: 51
name: multiHopTemplateAlpha
overridable: false
txRxInterval: MILLISECONDS
txRxMultiplier: 5
type: BFDTemplate
schema:
$ref: '#/components/schemas/BFDTemplate'
type: object
description: Accepted
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/bfdtemplates/{objectId}:
delete:
deprecated: false
description: '**Delete the Bidirectional Forwarding Detection routing template associated with the specified ID. _Check
the response section for applicable examples (if any)._**'
operationId: deleteBFDTemplate
parameters:
- description: Unique identifier of the Bidirectional Forwarding Detection routing template.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/bfdtemplates ( DELETE a SINGLE_HOP BFDTemplate
Object for the given UUID. )'
: value:
authentication:
authKey: '******'
authKeyId: 10
authType: MD5
pwdEncryption: UN_ENCRYPTED
echo: ENABLED
hopType: SINGLE_HOP
id: BFDTemplateUUID
links:
self: /fmc_config/v1/domain/DomainUUID/object/bfdtemplates/BFDTemplateUUID
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1613995959773.0
minReceive: 60
minTransmit: 60
name: singleHopTemplateAlpha
overridable: false
txRxInterval: MILLISECONDS
txRxMultiplier: 5
type: BFDTemplate
? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/bfdtemplates ( DELETE a MULTI_HOP BFDTemplate
Object for the given UUID. )'
: value:
authentication:
authKey: '******'
authKeyId: 10
authType: MD5
pwdEncryption: UN_ENCRYPTED
hopType: MULTI_HOP
id: BFDTemplateUUID
links:
self: /fmc_config/v1/domain/DomainUUID/object/bfdtemplates/BFDTemplateUUID
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1613995959773.0
minReceive: 60
minTransmit: 60
name: multiHopTemplateAlpha
overridable: false
txRxInterval: MILLISECONDS
txRxMultiplier: 5
type: BFDTemplate
schema:
$ref: '#/components/schemas/BFDTemplate'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the Bidirectional Forwarding Detection routing template associated with the specified ID.**'
operationId: getBFDTemplate
parameters:
- description: Unique identifier of the Bidirectional Forwarding Detection routing template.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/bfdtemplates/BFDTemplateUUID ( GET a SINGLE_HOP
BFDTemplate Object for the given UUID )'
: value:
authentication:
authKey: '******'
authKeyId: 10
authType: MD5
pwdEncryption: UN_ENCRYPTED
echo: ENABLED
hopType: SINGLE_HOP
id: BFDTemplateUUID
links:
self: /fmc_config/v1/domain/default/object/bfdtemplates/BFDTemplateUUID
metadata:
domain:
id: GloablDomainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1613996238500.0
minReceive: 60
minTransmit: 60
name: singleHopTemplateAlpha
overridable: false
txRxInterval: MILLISECONDS
txRxMultiplier: 5
type: BFDTemplate
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/bfdtemplates/BFDTemplateUUID ( GET a MULTI_HOP
BFDTemplate Object for the given UUID )'
: value:
authentication:
authKey: '******'
authKeyId: 10
authType: MD5
pwdEncryption: UN_ENCRYPTED
hopType: MULTI_HOP
id: BFDTemplateUUID
links:
self: /fmc_config/v1/domain/default/object/bfdtemplates/BFDTemplateUUID
metadata:
domain:
id: GloablDomainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1613996238500.0
minReceive: 60
minTransmit: 60
name: multiHopTemplateAlpha
overridable: false
txRxInterval: MILLISECONDS
txRxMultiplier: 5
type: BFDTemplate
schema:
$ref: '#/components/schemas/BFDTemplate'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the Bidirectional Forwarding Detection routing template associated with the specified ID. _Check
the response section for applicable examples (if any)._**'
operationId: updateBFDTemplate
parameters:
- description: Unique identifier of the Bidirectional Forwarding Detection routing template.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/bfdtemplates/BFDTemplateUUID ( UPDATE a SINGLE_HOP
BFDTemplate Object for the given UUID. )'
: value:
authentication:
authKey: Admin@123
authKeyId: 1
authType: MD5
pwdEncryption: UN_ENCRYPTED
echo: ENABLED
hopType: SINGLE_HOP
id: BFDTemplateUUID
minReceive: 52
minTransmit: 51
name: singleHopTemplateAlpha
overridable: false
txRxInterval: MILLISECONDS
txRxMultiplier: 5
type: BFDTemplate
? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/bfdtemplates/BFDTemplateUUID ( UPDATE a MULTI_HOP
BFDTemplate Object for the given UUID. )'
: value:
authentication:
authKey: Admin@123
authKeyId: 1
authType: MD5
pwdEncryption: UN_ENCRYPTED
hopType: MULTI_HOP
id: BFDTemplateUUID
minReceive: 52
minTransmit: 51
name: multiHopTemplateAlpha
overridable: false
txRxInterval: MILLISECONDS
txRxMultiplier: 5
type: BFDTemplate
schema:
$ref: '#/components/schemas/BFDTemplate'
type: object
description: Input representation of Bidirectional Forwarding Detection routing template object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/bfdtemplates/BFDTemplateUUID ( UPDATE a SINGLE_HOP
BFDTemplate Object for the given UUID. )'
: value:
authentication:
authKey: '********'
authKeyId: 1
authType: MD5
pwdEncryption: UN_ENCRYPTED
echo: ENABLED
hopType: SINGLE_HOP
id: BFDTemplateUUID
links:
self: /fmc_config/v1/domain/DomainUUID/object/bfdtemplates/BFDTemplateUUID
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1613995959773.0
minReceive: 52
minTransmit: 51
name: singleHopTemplateAlpha
overridable: false
txRxInterval: MILLISECONDS
txRxMultiplier: 5
type: BFDTemplate
? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/bfdtemplates/BFDTemplateUUID ( UPDATE a MULTI_HOP
BFDTemplate Object for the given UUID. )'
: value:
authentication:
authKey: '********'
authKeyId: 1
authType: MD5
pwdEncryption: UN_ENCRYPTED
hopType: MULTI_HOP
id: BFDTemplateUUID
links:
self: /fmc_config/v1/domain/DomainUUID/object/bfdtemplates/BFDTemplateUUID
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1613995959773.0
minReceive: 52
minTransmit: 51
name: multiHopTemplateAlpha
overridable: false
txRxInterval: MILLISECONDS
txRxMultiplier: 5
type: BFDTemplate
schema:
$ref: '#/components/schemas/BFDTemplate'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/bulkdynamicobjects:
post:
deprecated: false
description: '**Add or remove Dynamic Object Mappings for specific Dynamic Objects. _Check the response section for
applicable examples (if any)._**'
operationId: createDynamicObjectsBulk
parameters:
- description: Boolean value indicating whether to propagate dynamic object mappings. Default value is TRUE.
in: query
name: propagate
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/bulkdynamicobjects ( POST Dynamic Objects Bulk )':
value:
add:
- description: IPs of marketing department
name: Marketing
objectType: IP
type: DynamicObject
- description: IPs of sales department
name: Sales
objectType: IP
type: DynamicObject
remove:
agentIds:
- agent007
ids:
- 550e8400-e29b-41d4-a716-446655440000
- 550e8400-e29b-41d4-a716-446655441234
names:
- Research
schema:
$ref: '#/components/schemas/DynamicObjectsBulk'
type: object
description: Input representation of Dynamic Objects update.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/bulkdynamicobjects ( POST Dynamic Objects Bulk )':
value:
add:
- id: eb165e20-4047-4117-89c8-f0f9d2737dd3
name: Sales
status: SUCCESS
- name: Marketing
status: FAILED
statusMessage: Object already exists
remove:
- id: 550e8400-e29b-41d4-a716-446655440000
name: IT
status: SUCCESS
- id: 550e8400-e29b-41d4-a716-446655441234
name: Delivery
status: FAILED
statusMessage: Object in use
schema:
$ref: '#/components/schemas/DynamicObjectsBulk'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/certenrollments:
get:
deprecated: false
description: '**Get the list of all certificate enrollments.**'
operationId: getAllVpnCertEnrollmentModel
parameters:
- description: Filter to retrieve cert enrollment objects based on name.
in: query
name: filter
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: includeSseOwned
required: false
schema:
type: boolean
- description: Boolean indicating whether to return only SSE-owned certs.
in: query
name: onlySseOwned
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/certenrollments?expanded=false ( Get all paginated
certificate enrollment objects with expanded=false )'
: value:
items:
- enrollmentType: EST
id: 00000000-0000-0ed3-0000-081604378694
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-081604378694
name: est1
type: CertEnrollment
- enrollmentType: MANUAL
id: 00000000-0000-0ed3-0000-073014444119
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-073014444119
name: manual1
type: CertEnrollment
- enrollmentType: PKCS12
id: 00000000-0000-0ed3-0000-060129542264
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-060129542264
name: pkcs1
type: CertEnrollment
- enrollmentType: SCEP
id: 00000000-0000-0ed3-0000-064424509492
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-064424509492
name: scep1
type: CertEnrollment
- enrollmentType: SELF_SIGNED_CERTFICATE
id: 00000000-0000-0ed3-0000-073014444084
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-073014444084
name: selfsigned1
type: CertEnrollment
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments?offset=0&limit=5&expanded=false
paging:
count: 5
limit: 5
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/certenrollments?expanded=true ( Get all paginated
certificate enrollment objects with expanded=true )'
: value:
items:
- certificateParameters:
commonName: estcert
includeDeviceSerial: false
includeFQDN: DEFAULT
enrollmentType: EST
estContent:
enrollmentUrl: https://cisco.com
fingerprint: e6f7d542 e355586c a758e7cb bdcddd92
ignoreServerCertificateValidations: true
password: '*****'
sourceInterface:
id: 80934a56-653b-11ef-b0cf-8b66ea6b5b2a
name: sz1
type: SecurityZone
username: admin
id: 00000000-0000-0ed3-0000-150323856012
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323856012
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725431825124.0
name: est1
overridable: true
revocation:
certRevocationListContent:
enableCertRevocationList: false
enableCertRevocationListDistributionPoint: false
enableStaticCertRevocationList: false
evaluationPriority: NONE
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: false
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
- caCertificate:
base64Content: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7=='
caOnly: true
enrollmentType: MANUAL
id: 00000000-0000-0ed3-0000-150323856184
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323856184
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725431955876.0
name: manual1
overridable: false
revocation:
certRevocationListContent:
certRevocationStaticUrlList:
- http://cisco.com
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: true
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
onlineCertificateStatusProtocolUrl: http://cisco.com
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: false
- enrollmentType: PKCS12
id: 00000000-0000-0ed3-0000-150323855619
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855619
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725377600927.0
name: pkcs1
overridable: true
pkcs12Content:
base64Certificate: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7FAGECAggAgIIM0HDm106E+UKGgRbZItuD36V5DkJdhH7z5Fcmn4ih4bHrfNTe
Kwb5hzogxFDRNrYX+eJl7EZTg4uvUOPGBWTokvenyktrqd/V1Hwe+v39lA69qbOP
RReRzbvsShZxlrcM4fxlVEfy2EFg1Y02IappRM5hn93VyLGBhIDPW1aMAcmhzr1U
noXuq5oRtX==
'
passPhrase: '*********'
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
- certificateParameters:
countryCode: in
email: admin@cisco.com
includeDeviceIp: 10.10.7.169
includeDeviceSerial: true
includeFQDN: DEFAULT
locality: bgl
organization: cisco
organizationalUnit: sbg
state: karnataka
enrollmentType: SCEP
id: 00000000-0000-0ed3-0000-150323855939
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855939
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725431241326.0
name: scep1
overridable: true
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: OCSP
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
scepContent:
challengePassword: '*****'
enrollmentUrl: http://cisco.com
retryCount: '20'
retryPeriodInMins: '10'
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
- certificateParameters:
commonName: selfsignedcert
includeDeviceSerial: false
includeFQDN: DEFAULT
enrollmentType: SELF_SIGNED_CERTFICATE
id: 00000000-0000-0ed3-0000-150323856236
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_384
keyType: ECDSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323856236
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725433298720.0
name: selfsigned1
overridable: false
revocation:
certRevocationListContent:
certRevocationStaticUrlList:
- http://cisco.com
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: true
evaluationPriority: OCSP
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
onlineCertificateStatusProtocolUrl: http://cisco.com
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments?offset=0&limit=5&expanded=true
paging:
count: 5
limit: 5
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/VpnCertEnrollmentModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a certificate enrollment. A certificate enrollment can be of types PKCS12, SCEP, EST, Self-Signed,
or Manual with Only CA. _Check the response section for applicable examples (if any)._**'
operationId: createVpnCertEnrollmentModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/{domainUUID}/object/certenrollments ( POST operation for certificate
enrollment object of type PKCS12 )'
: value:
enrollmentType: PKCS12
name: pkcs1
overridable: true
pkcs12Content:
base64Certificate: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7FAGECAggAgIIM0HDm106E+UKGgRbZItuD36V5DkJdhH7z5Fcmn4ih4bHrfNTe
Kwb5hzogxFDRNrYX+eJl7EZTg4uvUOPGBWTokvenyktrqd/V1Hwe+v39lA69qbOP
RReRzbvsShZxlrcM4fxlVEfy2EFg1Y02IappRM5hn93VyLGBhIDPW1aMAcmhzr1U
noXuq5oRtXOeUEbk3zNNFJwjhLQGA0fIKCcm0GJ5xBvFiVWSor2b8Wee7Vr8YoG9
Tf/mY8y63rfELYsK7X39Cy09OaOkF8toNuO95wO7ogyLo9VRUUR50VTJrraRZyxv
PvHLtAr9eQ2P8g1EDAB0mFXHHgzvWA3gMvLhVKSjaUO6X1n+5eVl9dhnm9ky9hnW
kPEawC3+jhhfvMYOKDGWNQmfDehehrJK...'
passPhrase: test
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 2 : POST /fmc_config/v1/domain/{domainUUID}/object/certenrollments ( POST operation for certificate
enrollment object of type Manual with Only CA )'
: value:
caCertificate:
base64Content: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7=='
caOnly: true
enrollmentType: MANUAL
name: manual1
overridable: true
revocation:
certRevocationListContent:
certRevocationStaticUrlList:
- http://cisco.com
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: true
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
onlineCertificateStatusProtocolUrl: http://cisco.com
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: false
? 'Example 3 : POST /fmc_config/v1/domain/{domainUUID}/object/certenrollments ( POST operation for certificate
enrollment object of type SCEP )'
: value:
certificateParameters:
countryCode: in
email: admin@cisco.com
includeDeviceIp: 10.10.7.169
includeDeviceSerial: true
includeFQDN: DEFAULT
locality: bgl
organization: cisco
organizationalUnit: sbg
state: karnataka
enrollmentType: SCEP
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
name: scep1
overridable: true
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: OCSP
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
scepContent:
challengePassword: test
enrollmentUrl: http://cisco.com
fingerprint: abcdefabcdefabcdefabcdef0123456789012345
retryCount: '10'
retryPeriodInMins: '1'
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 4 : POST /fmc_config/v1/domain/{domainUUID}/object/certenrollments ( POST operation for certificate
enrollment object of type EST )'
: value:
certificateParameters:
commonName: estcert
includeDeviceSerial: false
includeFQDN: DEFAULT
enrollmentType: EST
estContent:
enrollmentUrl: https://cisco.com
ignoreServerCertificateValidations: false
password: test
sourceInterface:
id: 44a1e774-65fd-11ef-aabf-8c84d717912a
name: sz2
type: SecurityZone
username: admin
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
name: EST1
overridable: false
revocation:
certRevocationListContent:
enableCertRevocationList: false
enableCertRevocationListDistributionPoint: false
enableStaticCertRevocationList: false
evaluationPriority: NONE
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: false
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 5 : POST /fmc_config/v1/domain/{domainUUID}/object/certenrollments ( POST operation for certificate
enrollment object of type Self-Signed )'
: value:
certificateParameters:
commonName: selfsignedcertificate
email: bgl@cisco.com
includeDeviceIp: 10.10.7.169
includeDeviceSerial: true
includeFQDN: DEFAULT
locality: bgl
organization: cisco
organizationalUnit: sbg
state: karnataka
enrollmentType: SELF_SIGNED_CERTFICATE
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
name: selfsigned1
overridable: true
revocation:
certRevocationListContent:
certRevocationStaticUrlList:
- http://cisco.com
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: true
evaluationPriority: OCSP
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
onlineCertificateStatusProtocolUrl: http://cisco.com
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 6 : POST /fmc_config/v1/domain/{domainUUID}/object/certenrollments ( POST operation for certificate
enrollment object override )'
: value:
enrollmentType: PKCS12
id: 00000000-0000-0ed3-0000-150323855619
name: pkcs1
overridable: true
overrides:
parent:
id: 00000000-0000-0ed3-0000-150323855619
type: CertEnrollment
target:
id: 2216f72e-3922-11ef-a688-b7766339d339
name: FTD-1
type: Device
pkcs12Content:
base64Certificate: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7FAGECAggAgIIM0HDm106E+UKGgRbZItuD36V5DkJdhH7z5Fcmn4ih4bHrfNTe
Kwb5hzogxFDRNrYX+eJl7EZTg4uvUOPGBWTokvenyktrqd/V1Hwe+v39lA69qbOP
RReRzbvsShZxlrcM4fxlVEfy2EFg1Y02IappRM5hn93VyLGBhIDPW1aMAcmhzr1U
noXuq5oRtXOeUEbk3zNNFJwjhLQGA0fIKCcm0GJ5xBvFiVWSor2b8Wee7Vr8YoG9
Tf/mY8y63rfELYsK7X39Cy09OaOkF8toNuO95wO7ogyLo9VRUUR50VTJrraRZyxv
PvHLtAr9eQ2P8g1EDAB0mFXHHgzvWA3gMvLhVKSjaUO6X1n+5eVl9dhnm9ky9hnW
kPEawC3+jhhfvMYOKDGWNQmfDehehrJK...'
passPhrase: test
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
schema:
$ref: '#/components/schemas/VpnCertEnrollmentModel'
type: object
description: Input representation of cert enrollment object.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/{domainUUID}/object/certenrollments ( POST operation for certificate
enrollment object of type PKCS12 )'
: value:
enrollmentType: PKCS12
id: 00000000-0000-0ed3-0000-150323855619
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855619
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725377600927.0
name: pkcs1
overridable: true
pkcs12Content:
base64Certificate: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7FAGECAggAgIIM0HDm106E+UKGgRbZItuD36V5DkJdhH7z5Fcmn4ih4bHrfNTe
Kwb5hzogxFDRNrYX+eJl7EZTg4uvUOPGBWTokvenyktrqd/V1Hwe+v39lA69qbOP
RReRzbvsShZxlrcM4fxlVEfy2EFg1Y02IappRM5hn93VyLGBhIDPW1aMAcmhzr1U
noXuq5oRtX==
'
passPhrase: '*********'
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 2 : POST /fmc_config/v1/domain/{domainUUID}/object/certenrollments ( POST operation for certificate
enrollment object of type Manual with Only CA )'
: value:
caCertificate:
base64Content: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7=='
caOnly: true
enrollmentType: MANUAL
id: 00000000-0000-0ed3-0000-073014444119
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-073014444119
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1724845677148.0
name: manual1
overridable: true
revocation:
certRevocationListContent:
certRevocationStaticUrlList:
- http://cisco.com
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: true
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
onlineCertificateStatusProtocolUrl: http://cisco.com
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: false
? 'Example 3 : POST /fmc_config/v1/domain/{domainUUID}/object/certenrollments ( POST operation for certificate
enrollment object of type SCEP )'
: value:
certificateParameters:
countryCode: in
email: admin@cisco.com
includeDeviceIp: 10.10.7.169
includeDeviceSerial: true
includeFQDN: DEFAULT
locality: bgl
organization: cisco
organizationalUnit: sbg
state: karnataka
enrollmentType: SCEP
id: 00000000-0000-0ed3-0000-150323855939
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855939
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725431241326.0
name: scep1
overridable: true
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: OCSP
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
scepContent:
challengePassword: '*****'
enrollmentUrl: http://cisco.com
retryCount: '20'
retryPeriodInMins: '10'
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 4 : POST /fmc_config/v1/domain/{domainUUID}/object/certenrollments ( POST operation for certificate
enrollment object of type EST )'
: value:
certificateParameters:
commonName: estcert
includeDeviceSerial: false
includeFQDN: DEFAULT
enrollmentType: EST
estContent:
enrollmentUrl: https://cisco.com
ignoreServerCertificateValidations: false
password: '*****'
sourceInterface:
id: 44a1e774-65fd-11ef-aabf-8c84d717912a
name: sz2
type: SecurityZone
username: admin
id: 00000000-0000-0ed3-0000-085899346630
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-085899346630
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1724932706132.0
name: EST1
overridable: false
revocation:
certRevocationListContent:
enableCertRevocationList: false
enableCertRevocationListDistributionPoint: false
enableStaticCertRevocationList: false
evaluationPriority: NONE
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: false
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 5 : POST /fmc_config/v1/domain/{domainUUID}/object/certenrollments ( POST operation for certificate
enrollment object of type Self-Signed )'
: value:
certificateParameters:
commonName: selfsignedcertificate
email: bgl@cisco.com
includeDeviceIp: 10.10.7.169
includeDeviceSerial: true
includeFQDN: DEFAULT
locality: bgl
organization: cisco
organizationalUnit: sbg
state: karnataka
enrollmentType: SELF_SIGNED_CERTFICATE
id: 00000000-0000-0ed3-0000-073014444084
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-073014444084
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1724845356843.0
name: selfsigned1
overridable: true
revocation:
certRevocationListContent:
certRevocationStaticUrlList:
- http://cisco.com
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: true
evaluationPriority: OCSP
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
onlineCertificateStatusProtocolUrl: http://cisco.com
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 6 : POST /fmc_config/v1/domain/{domainUUID}/object/certenrollments ( POST operation for certificate
enrollment object override )'
: value:
enrollmentType: PKCS12
id: 00000000-0000-0ed3-0000-150323855619
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855619
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725377600927.0
name: pkcs1
overridable: true
overrides:
parent:
id: 00000000-0000-0ed3-0000-150323855619
type: CertEnrollment
target:
id: 2216f72e-3922-11ef-a688-b7766339d339
name: FTD-1
type: Device
pkcs12Content:
base64Certificate: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7FAGECAggAgIIM0HDm106E+UKGgRbZItuD36V5DkJdhH7z5Fcmn4ih4bHrfNTe
Kwb5hzogxFDRNrYX+eJl7EZTg4uvUOPGBWTokvenyktrqd/V1Hwe+v39lA69qbOP
RReRzbvsShZxlrcM4fxlVEfy2EFg1Y02IappRM5hn93VyLGBhIDPW1aMAcmhzr1U
noXuq5oRtX==
'
passPhrase: '*********'
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
schema:
$ref: '#/components/schemas/VpnCertEnrollmentModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/certenrollments/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get list of all certificate enrollment object overrides within the specified containerUUID.**'
operationId: getVpnCertEnrollmentOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/certenrollments/certenrollmentobjectUUID/overrides
( Get all paginated certificate enrollment object overrides )'
: value:
items:
- certificateParameters:
commonName: scepoverride
countryCode: in
email: admin@cisco.com
includeDeviceIp: 10.10.7.169
includeDeviceSerial: true
includeFQDN: DEFAULT
locality: bgl
organization: cisco
organizationalUnit: sbg
state: karnataka
enrollmentType: SCEP
id: 00000000-0000-0ed3-0000-150323855939
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
parent: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855939
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855939?overrideTargetId=2216f72e-3922-11ef-a688-b7766339d339
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725952194534.0
name: scep1
overridable: true
overrides:
parent:
id: 00000000-0000-0ed3-0000-150323855939
type: CertEnrollment
target:
id: 2216f72e-3922-11ef-a688-b7766339d339
name: FTD-2
type: Device
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: OCSP
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
scepContent:
challengePassword: '*****'
enrollmentUrl: http://cisco.com
retryCount: '20'
retryPeriodInMins: '10'
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855939/overrides?offset=0&limit=25&expanded=true
paging:
count: 1
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/VpnCertEnrollmentOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId}:
delete:
deprecated: false
description: '**Delete the specified certificate enrollment. _Check the response section for applicable examples (if
any)._**'
operationId: deleteVpnCertEnrollmentModel
parameters:
- description: Unique identifier of the certificate enrollment.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the target on which the object override is present.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( DELETE operation
for certificate enrollment object of type PKCS12 )'
: value:
enrollmentType: PKCS12
id: 00000000-0000-0ed3-0000-150323855619
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855619
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725377600927.0
name: pkcs1
overridable: true
pkcs12Content:
base64Certificate: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7FAGECAggAgIIM0HDm106E+UKGgRbZItuD36V5DkJdhH7z5Fcmn4ih4bHrfNTe
Kwb5hzogxFDRNrYX+eJl7EZTg4uvUOPGBWTokvenyktrqd/V1Hwe+v39lA69qbOP
RReRzbvsShZxlrcM4fxlVEfy2EFg1Y02IappRM5hn93VyLGBhIDPW1aMAcmhzr1U
noXuq5oRtX==
'
passPhrase: '*********'
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 2 : DELETE /fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( DELETE operation
for certificate enrollment object of type Manual with Only CA )'
: value:
caCertificate:
base64Content: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7=='
caOnly: true
enrollmentType: MANUAL
id: 00000000-0000-0ed3-0000-073014444119
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-073014444119
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1724845677148.0
name: manual1
overridable: true
revocation:
certRevocationListContent:
certRevocationStaticUrlList:
- http://cisco.com
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: true
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
onlineCertificateStatusProtocolUrl: http://cisco.com
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: false
? 'Example 3 : DELETE /fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( DELETE operation
for certificate enrollment object of type SCEP )'
: value:
certificateParameters:
countryCode: in
email: admin@cisco.com
includeDeviceIp: 10.10.7.169
includeDeviceSerial: true
includeFQDN: DEFAULT
locality: bgl
organization: cisco
organizationalUnit: sbg
state: karnataka
enrollmentType: SCEP
id: 00000000-0000-0ed3-0000-150323855939
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855939
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725431241326.0
name: scep1
overridable: true
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: OCSP
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
scepContent:
challengePassword: '*****'
enrollmentUrl: http://cisco.com
retryCount: '20'
retryPeriodInMins: '10'
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 4 : DELETE /fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( DELETE operation
for certificate enrollment object of type EST )'
: value:
certificateParameters:
commonName: estcert
includeDeviceSerial: false
includeFQDN: DEFAULT
enrollmentType: EST
estContent:
enrollmentUrl: https://cisco.com
ignoreServerCertificateValidations: false
password: '*****'
sourceInterface:
id: 44a1e774-65fd-11ef-aabf-8c84d717912a
name: sz2
type: SecurityZone
username: admin
id: 00000000-0000-0ed3-0000-085899346630
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-085899346630
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1724932706132.0
name: EST1
overridable: false
revocation:
certRevocationListContent:
enableCertRevocationList: false
enableCertRevocationListDistributionPoint: false
enableStaticCertRevocationList: false
evaluationPriority: NONE
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: false
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 5 : DELETE /fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( DELETE operation
for certificate enrollment object of type Self-Signed )'
: value:
certificateParameters:
commonName: selfsignedcertificate
email: bgl@cisco.com
includeDeviceIp: 10.10.7.169
includeDeviceSerial: true
includeFQDN: DEFAULT
locality: bgl
organization: cisco
organizationalUnit: sbg
state: karnataka
enrollmentType: SELF_SIGNED_CERTFICATE
id: 00000000-0000-0ed3-0000-073014444084
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-073014444084
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1724845356843.0
name: selfsigned1
overridable: true
revocation:
certRevocationListContent:
certRevocationStaticUrlList:
- http://cisco.com
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: true
evaluationPriority: OCSP
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
onlineCertificateStatusProtocolUrl: http://cisco.com
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 6 : DELETE /fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId}?overrideTargetId=2216f72e-3922-11ef-a688-b7766339d339
( DELETE operation for certificate enrollment object override )'
: value:
enrollmentType: PKCS12
id: 00000000-0000-0ed3-0000-150323855619
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855619
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725377600927.0
name: pkcs1
overridable: true
overrides:
parent:
id: 00000000-0000-0ed3-0000-150323855619
type: CertEnrollment
target:
id: 2216f72e-3922-11ef-a688-b7766339d339
name: FTD-1
type: Device
pkcs12Content:
base64Certificate: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7FAGECAggAgIIM0HDm106E+UKGgRbZItuD36V5DkJdhH7z5Fcmn4ih4bHrfNTe
Kwb5hzogxFDRNrYX+eJl7EZTg4uvUOPGBWTokvenyktrqd/V1Hwe+v39lA69qbOP
RReRzbvsShZxlrcM4fxlVEfy2EFg1Y02IappRM5hn93VyLGBhIDPW1aMAcmhzr1U
noXuq5oRtX==
'
passPhrase: '*********'
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
schema:
$ref: '#/components/schemas/VpnCertEnrollmentModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the specified certificate enrollment.**'
operationId: getVpnCertEnrollmentModel
parameters:
- description: Unique identifier of the certificate enrollment.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( GET operation for
certificate enrollment object of type PKCS12 )'
: value:
enrollmentType: PKCS12
id: 00000000-0000-0ed3-0000-150323855619
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855619
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725377600927.0
name: pkcs1
overridable: true
pkcs12Content:
base64Certificate: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7FAGECAggAgIIM0HDm106E+UKGgRbZItuD36V5DkJdhH7z5Fcmn4ih4bHrfNTe
Kwb5hzogxFDRNrYX+eJl7EZTg4uvUOPGBWTokvenyktrqd/V1Hwe+v39lA69qbOP
RReRzbvsShZxlrcM4fxlVEfy2EFg1Y02IappRM5hn93VyLGBhIDPW1aMAcmhzr1U
noXuq5oRtX==
'
passPhrase: '*********'
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 2 : GET /fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( GET operation for
certificate enrollment object of type Manual with Only CA )'
: value:
caCertificate:
base64Content: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7=='
caOnly: true
enrollmentType: MANUAL
id: 00000000-0000-0ed3-0000-073014444119
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-073014444119
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1724845677148.0
name: manual1
overridable: true
revocation:
certRevocationListContent:
certRevocationStaticUrlList:
- http://cisco.com
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: true
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
onlineCertificateStatusProtocolUrl: http://cisco.com
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: false
? 'Example 3 : GET /fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( GET operation for
certificate enrollment object of type SCEP )'
: value:
certificateParameters:
countryCode: in
email: admin@cisco.com
includeDeviceIp: 10.10.7.169
includeDeviceSerial: true
includeFQDN: DEFAULT
locality: bgl
organization: cisco
organizationalUnit: sbg
state: karnataka
enrollmentType: SCEP
id: 00000000-0000-0ed3-0000-150323855939
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855939
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725431241326.0
name: scep1
overridable: true
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: OCSP
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
scepContent:
challengePassword: '*****'
enrollmentUrl: http://cisco.com
retryCount: '20'
retryPeriodInMins: '10'
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 4 : GET /fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( GET operation for
certificate enrollment object of type EST )'
: value:
certificateParameters:
commonName: estcert
includeDeviceSerial: false
includeFQDN: DEFAULT
enrollmentType: EST
estContent:
enrollmentUrl: https://cisco.com
ignoreServerCertificateValidations: false
password: '*****'
sourceInterface:
id: 44a1e774-65fd-11ef-aabf-8c84d717912a
name: sz2
type: SecurityZone
username: admin
id: 00000000-0000-0ed3-0000-085899346630
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-085899346630
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1724932706132.0
name: EST1
overridable: false
revocation:
certRevocationListContent:
enableCertRevocationList: false
enableCertRevocationListDistributionPoint: false
enableStaticCertRevocationList: false
evaluationPriority: NONE
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: false
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 5 : GET /fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( GET operation for
certificate enrollment object of type Self-Signed )'
: value:
certificateParameters:
commonName: selfsignedcertificate
email: bgl@cisco.com
includeDeviceIp: 10.10.7.169
includeDeviceSerial: true
includeFQDN: DEFAULT
locality: bgl
organization: cisco
organizationalUnit: sbg
state: karnataka
enrollmentType: SELF_SIGNED_CERTFICATE
id: 00000000-0000-0ed3-0000-073014444084
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-073014444084
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1724845356843.0
name: selfsigned1
overridable: true
revocation:
certRevocationListContent:
certRevocationStaticUrlList:
- http://cisco.com
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: true
evaluationPriority: OCSP
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
onlineCertificateStatusProtocolUrl: http://cisco.com
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
schema:
$ref: '#/components/schemas/VpnCertEnrollmentModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the specified certificate enrollment. _Check the response section for applicable examples (if
any)._**'
operationId: updateVpnCertEnrollmentModel
parameters:
- description: Unique identifier of the certificate enrollment.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( PUT operation for certificate
enrollment object of type PKCS12 )'
: value:
enrollmentType: PKCS12
id: 00000000-0000-0ed3-0000-150323855619
name: pkcs1
overridable: true
pkcs12Content:
base64Certificate: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7FAGECAggAgIIM0HDm106E+UKGgRbZItuD36V5DkJdhH7z5Fcmn4ih4bHrfNTe
Kwb5hzogxFDRNrYX+eJl7EZTg4uvUOPGBWTokvenyktrqd/V1Hwe+v39lA69qbOP
RReRzbvsShZxlrcM4fxlVEfy2EFg1Y02IappRM5hn93VyLGBhIDPW1aMAcmhzr1U
noXuq5oRtXOeUEbk3zNNFJwjhLQGA0fIKCcm0GJ5xBvFiVWSor2b8Wee7Vr8YoG9
Tf/mY8y63rfELYsK7X39Cy09OaOkF8toNuO95wO7ogyLo9VRUUR50VTJrraRZyxv
PvHLtAr9eQ2P8g1EDAB0mFXHHgzvWA3gMvLhVKSjaUO6X1n+5eVl9dhnm9ky9hnW
kPEawC3+jhhfvMYOKDGWNQmfDehehrJK...'
passPhrase: test
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 2 : PUT fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( PUT operation for certificate
enrollment object of type Manual with Only CA )'
: value:
caCertificate:
base64Content: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7=='
caOnly: true
enrollmentType: MANUAL
id: 00000000-0000-0ed3-0000-073014444119
name: manual1
overridable: true
revocation:
certRevocationListContent:
certRevocationStaticUrlList:
- http://cisco.com
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: true
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
onlineCertificateStatusProtocolUrl: http://cisco.com
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: false
? 'Example 3 : PUT fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( PUT operation for certificate
enrollment object of type SCEP )'
: value:
certificateParameters:
countryCode: in
email: admin@cisco.com
includeDeviceIp: 10.10.7.169
includeDeviceSerial: true
includeFQDN: DEFAULT
locality: bgl
organization: cisco
organizationalUnit: sbg
state: karnataka
enrollmentType: SCEP
id: 00000000-0000-0ed3-0000-150323855939
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
name: scep1
overridable: true
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: OCSP
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
scepContent:
challengePassword: test
enrollmentUrl: http://cisco.com
fingerprint: abcdefabcdefabcdefabcdef0123456789012345
retryCount: '10'
retryPeriodInMins: '1'
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 4 : PUT fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( PUT operation for certificate
enrollment object of type EST )'
: value:
certificateParameters:
commonName: estcert
includeDeviceSerial: false
includeFQDN: DEFAULT
enrollmentType: EST
estContent:
enrollmentUrl: https://cisco.com
ignoreServerCertificateValidations: false
password: test
sourceInterface:
id: 44a1e774-65fd-11ef-aabf-8c84d717912a
name: sz2
type: SecurityZone
username: admin
id: 00000000-0000-0ed3-0000-085899346630
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
name: EST1
overridable: false
revocation:
certRevocationListContent:
enableCertRevocationList: false
enableCertRevocationListDistributionPoint: false
enableStaticCertRevocationList: false
evaluationPriority: NONE
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: false
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 5 : PUT fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( PUT operation for certificate
enrollment object of type Self-Signed )'
: value:
certificateParameters:
commonName: selfsignedcertificate
email: bgl@cisco.com
includeDeviceIp: 10.10.7.169
includeDeviceSerial: true
includeFQDN: DEFAULT
locality: bgl
organization: cisco
organizationalUnit: sbg
state: karnataka
enrollmentType: SELF_SIGNED_CERTFICATE
id: 00000000-0000-0ed3-0000-073014444084
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
name: selfsigned1
overridable: true
revocation:
certRevocationListContent:
certRevocationStaticUrlList:
- http://cisco.com
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: true
evaluationPriority: OCSP
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
onlineCertificateStatusProtocolUrl: http://cisco.com
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 6 : PUT fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( PUT operation for certificate
enrollment object override )'
: value:
enrollmentType: PKCS12
id: 00000000-0000-0ed3-0000-150323855619
name: pkcs1
overridable: true
overrides:
parent:
id: 00000000-0000-0ed3-0000-150323855619
type: CertEnrollment
target:
id: 2216f72e-3922-11ef-a688-b7766339d339
name: FTD-1
type: Device
pkcs12Content:
base64Certificate: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7FAGECAggAgIIM0HDm106E+UKGgRbZItuD36V5DkJdhH7z5Fcmn4ih4bHrfNTe
Kwb5hzogxFDRNrYX+eJl7EZTg4uvUOPGBWTokvenyktrqd/V1Hwe+v39lA69qbOP
RReRzbvsShZxlrcM4fxlVEfy2EFg1Y02IappRM5hn93VyLGBhIDPW1aMAcmhzr1U
noXuq5oRtXOeUEbk3zNNFJwjhLQGA0fIKCcm0GJ5xBvFiVWSor2b8Wee7Vr8YoG9
Tf/mY8y63rfELYsK7X39Cy09OaOkF8toNuO95wO7ogyLo9VRUUR50VTJrraRZyxv
PvHLtAr9eQ2P8g1EDAB0mFXHHgzvWA3gMvLhVKSjaUO6X1n+5eVl9dhnm9ky9hnW
kPEawC3+jhhfvMYOKDGWNQmfDehehrJK...'
passPhrase: test
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
schema:
$ref: '#/components/schemas/VpnCertEnrollmentModel'
type: object
description: Input representation of cert enrollment object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( PUT operation for
certificate enrollment object of type PKCS12 )'
: value:
enrollmentType: PKCS12
id: 00000000-0000-0ed3-0000-150323855619
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855619
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725377600927.0
name: pkcs1
overridable: true
pkcs12Content:
base64Certificate: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7FAGECAggAgIIM0HDm106E+UKGgRbZItuD36V5DkJdhH7z5Fcmn4ih4bHrfNTe
Kwb5hzogxFDRNrYX+eJl7EZTg4uvUOPGBWTokvenyktrqd/V1Hwe+v39lA69qbOP
RReRzbvsShZxlrcM4fxlVEfy2EFg1Y02IappRM5hn93VyLGBhIDPW1aMAcmhzr1U
noXuq5oRtX==
'
passPhrase: '*********'
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 2 : PUT fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( PUT operation for
certificate enrollment object of type Manual with Only CA )'
: value:
caCertificate:
base64Content: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7=='
caOnly: true
enrollmentType: MANUAL
id: 00000000-0000-0ed3-0000-073014444119
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-073014444119
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1724845677148.0
name: manual1
overridable: true
revocation:
certRevocationListContent:
certRevocationStaticUrlList:
- http://cisco.com
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: true
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
onlineCertificateStatusProtocolUrl: http://cisco.com
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: false
? 'Example 3 : PUT fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( PUT operation for
certificate enrollment object of type SCEP )'
: value:
certificateParameters:
countryCode: in
email: admin@cisco.com
includeDeviceIp: 10.10.7.169
includeDeviceSerial: true
includeFQDN: DEFAULT
locality: bgl
organization: cisco
organizationalUnit: sbg
state: karnataka
enrollmentType: SCEP
id: 00000000-0000-0ed3-0000-150323855939
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855939
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725431241326.0
name: scep1
overridable: true
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: OCSP
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
scepContent:
challengePassword: '*****'
enrollmentUrl: http://cisco.com
retryCount: '20'
retryPeriodInMins: '10'
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 4 : PUT fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( PUT operation for
certificate enrollment object of type EST )'
: value:
certificateParameters:
commonName: estcert
includeDeviceSerial: false
includeFQDN: DEFAULT
enrollmentType: EST
estContent:
enrollmentUrl: https://cisco.com
ignoreServerCertificateValidations: false
password: '*****'
sourceInterface:
id: 44a1e774-65fd-11ef-aabf-8c84d717912a
name: sz2
type: SecurityZone
username: admin
id: 00000000-0000-0ed3-0000-085899346630
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-085899346630
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1724932706132.0
name: EST1
overridable: false
revocation:
certRevocationListContent:
enableCertRevocationList: false
enableCertRevocationListDistributionPoint: false
enableStaticCertRevocationList: false
evaluationPriority: NONE
ignoreRevocation: true
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: false
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 5 : PUT fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( PUT operation for
certificate enrollment object of type Self-Signed )'
: value:
certificateParameters:
commonName: selfsignedcertificate
email: bgl@cisco.com
includeDeviceIp: 10.10.7.169
includeDeviceSerial: true
includeFQDN: DEFAULT
locality: bgl
organization: cisco
organizationalUnit: sbg
state: karnataka
enrollmentType: SELF_SIGNED_CERTFICATE
id: 00000000-0000-0ed3-0000-073014444084
key:
ignoreIpsecKeyusage: false
keyName:
keySize: CertKey_2048
keyType: RSA
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-073014444084
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1724845356843.0
name: selfsigned1
overridable: true
revocation:
certRevocationListContent:
certRevocationStaticUrlList:
- http://cisco.com
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: true
evaluationPriority: OCSP
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
onlineCertificateStatusProtocolUrl: http://cisco.com
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
? 'Example 6 : PUT fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId} ( PUT operation for
certificate enrollment object override )'
: value:
enrollmentType: PKCS12
id: 00000000-0000-0ed3-0000-150323855619
links:
self: https://u32c01p12-vrouter.cisco.com:17707/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/certenrollments/00000000-0000-0ed3-0000-150323855619
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin1
timestamp: 1725377600927.0
name: pkcs1
overridable: true
overrides:
parent:
id: 00000000-0000-0ed3-0000-150323855619
type: CertEnrollment
target:
id: 2216f72e-3922-11ef-a688-b7766339d339
name: FTD-1
type: Device
pkcs12Content:
base64Certificate: 'MIIS2AIBAzCCEp4GCSqGSIb3DQEHAaCCEo8EghKLMIIShzCCDRcGCSqGSIb3DQEH
BqCCDQgwgg0EAgEAMIIM/QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIh2mr
rR7FAGECAggAgIIM0HDm106E+UKGgRbZItuD36V5DkJdhH7z5Fcmn4ih4bHrfNTe
Kwb5hzogxFDRNrYX+eJl7EZTg4uvUOPGBWTokvenyktrqd/V1Hwe+v39lA69qbOP
RReRzbvsShZxlrcM4fxlVEfy2EFg1Y02IappRM5hn93VyLGBhIDPW1aMAcmhzr1U
noXuq5oRtX==
'
passPhrase: '*********'
revocation:
certRevocationListContent:
enableCertRevocationList: true
enableCertRevocationListDistributionPoint: true
enableStaticCertRevocationList: false
evaluationPriority: CRL
ignoreRevocation: false
onlineCertificateStatusProtocolContent:
enableOnlineCertificateStatusProtocol: true
skipCaFlagCheck: false
type: CertEnrollment
validationUsage:
ipsecClient: true
sslClient: true
sslServer: true
schema:
$ref: '#/components/schemas/VpnCertEnrollmentModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/certificatemaps:
get:
deprecated: false
description: '**Get the list of all certificate maps.**'
operationId: getAllCertificateMapModel
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/certificatemaps?limit=1 ( Get all paginated certificate
map objects with limit=1 )'
: value:
items:
- id: String
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/certificatemaps/{objectId}
name: String
rules:
- component: WHOLE_FIELD
field: SUBJECT
operator: EQUALS
value: username
type: CertificateMap
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/certificatemaps?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/CertificateMapModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a certificate map. _Check the response section for applicable examples (if any)._**'
operationId: createCertificateMapModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateMapModel'
type: object
description: Input representation of Certificate Map object.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateMapModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/certificatemaps/{objectId}:
delete:
deprecated: false
description: '**Delete the certificate map associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteCertificateMapModel
parameters:
- description: Unique identifier of the certificate map.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/{domainUUID}/object/certificatemaps/{objectId} ( Delete operation
for certificate map objects for particuler object ID )'
: value:
description: ' '
id: 00505681-2B65-0ed3-0000-103079215255
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/certificatemaps/{objectId}
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: rest
timestamp: 1636354812813.0
name: map6
rules:
- component: ORGANIZATION
field: ISSUER
operator: EQUALS
value: '101'
type: CertificateMap
schema:
$ref: '#/components/schemas/CertificateMapModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the certificate map associated with the specified ID.**'
operationId: getCertificateMapModel
parameters:
- description: Unique identifier of the certificate map.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/certificatemaps/ObjectId ( Get certificate map
objects for particuler object ID )'
: value:
id: String
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/certificatemaps/{objectId}
name: String
paging:
count: 1
limit: 1
offset: 0
pages: 1
rules:
- component: WHOLE_FIELD
field: SUBJECT
operator: EQUALS
value: username
type: CertificateMap
schema:
$ref: '#/components/schemas/CertificateMapModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the certificate map associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateCertificateMapModel
parameters:
- description: Unique identifier of the certificate map.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/{domainUUID}/object/certificatemaps/{objectId} ( PUT operation for
certificate map objects for particuler object ID )'
: value:
description: ' '
name: map6
rules:
- component: ORGANISATION
field: ISSUER
operator: EQUALS
value: username
type: CertificateMap
schema:
$ref: '#/components/schemas/CertificateMapModel'
type: object
description: Input representation of Certificate Map object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/{domainUUID}/object/certificatemaps/{objectId} ( PUT operation for
certificate map objects for particuler object ID )'
: value:
description: ' '
id: 00505681-2B65-0ed3-0000-103079215255
links:
self: https:///api/fmc_config/v1/domain/{domainUUID}/object/certificatemaps/{objectId}
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: rest
timestamp: 0
name: map6
rules:
- component: ORGANISATION
field: ISSUER
operator: EQUALS
value: username
type: CertificateMap
schema:
$ref: '#/components/schemas/CertificateMapModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ciphersuitelists:
get:
deprecated: false
description: '**Get all cipher suite lists.**'
operationId: getCipherSuiteList
parameters:
- description: Filter by name of the cipher suite list is supported.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CipherSuiteListListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a cipher suite list. _Check the response section for applicable examples (if any)._**'
operationId: createCipherSuiteList
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CipherSuiteList'
type: object
description: Input representation of cipher suite list objects.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CipherSuiteList'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/communitylists:
get:
deprecated: false
description: '**Get all community lists.**'
operationId: getAllCommunityList
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/communitylists ( Success: Test GET ALL success )':
value: {}
'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/communitylists ( Success: Test GET ALL success )':
value: {}
schema:
$ref: '#/components/schemas/CommunityListListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/communitylists/{objectId}:
get:
deprecated: false
description: '**Get the specified community list.**'
operationId: getCommunityList
parameters:
- description: Unique identifier of the community list.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CommunityList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/continents:
get:
deprecated: false
description: '**Get the list of all continents.**'
operationId: getAllContinentObject
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/continents?limit=2 ( Get all paginated continent
objects with limit set 2 )'
: value:
items:
- id: '6'
links:
self: /fmc_config/v1/domain/DomainUUID/object/continents/6
name: North America
type: Continent
- id: '4'
links:
self: /fmc_config/v1/domain/DomainUUID/object/continents/4
name: Asia
type: Continent
links:
self: /fmc_config/v1/domain/DomainUUID/object/continents?offset=0&limit=2
paging:
count: 7
limit: 2
next:
- /fmc_config/v1/domain/DomainUUID/object/continents?offset=2&limit=2
- /fmc_config/v1/domain/DomainUUID/object/continents?offset=4&limit=2
- /fmc_config/v1/domain/DomainUUID/object/continents?offset=6&limit=1
offset: 0
pages: 4
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/continents?limit=1&expanded=true ( Get all paginated
continent objects with limit set 1 )'
: value:
items:
- countries:
- id: '533'
iso2: aw
iso3: abw
name: Aruba
type: Country
- id: '660'
iso2: ai
iso3: aia
name: Anguilla
type: Country
- id: '530'
iso2: an
iso3: ant
name: Netherlands Antilles
type: Country
- id: '28'
iso2: ag
iso3: atg
name: Antigua and Barbuda
type: Country
- id: '535'
iso2: bq
iso3: bes
name: Bonaire, Sint Eustatius and Saba
type: Country
- id: '44'
iso2: bs
iso3: bhs
name: Bahamas
type: Country
- id: '652'
iso2: bl
iso3: blm
name: Saint Barthélemy
type: Country
- id: '84'
iso2: bz
iso3: blz
name: Belize
type: Country
- id: '60'
iso2: bm
iso3: bmu
name: Bermuda
type: Country
- id: '52'
iso2: bb
iso3: brb
name: Barbados
type: Country
- id: '124'
iso2: ca
iso3: can
name: Canada
type: Country
- id: '188'
iso2: cr
iso3: cri
name: Costa Rica
type: Country
- id: '192'
iso2: cu
iso3: cub
name: Cuba
type: Country
- id: '531'
iso2: cw
iso3: cuw
name: Curaçao
type: Country
- id: '136'
iso2: ky
iso3: cym
name: Cayman Islands
type: Country
- id: '212'
iso2: dm
iso3: dma
name: Dominica
type: Country
- id: '214'
iso2: do
iso3: dom
name: Dominican Republic
type: Country
- id: '312'
iso2: gp
iso3: glp
name: Guadeloupe
type: Country
- id: '308'
iso2: gd
iso3: grd
name: Grenada
type: Country
- id: '304'
iso2: gl
iso3: grl
name: Greenland
type: Country
- id: '320'
iso2: gt
iso3: gtm
name: Guatemala
type: Country
- id: '340'
iso2: hn
iso3: hnd
name: Honduras
type: Country
- id: '332'
iso2: ht
iso3: hti
name: Haiti
type: Country
- id: '388'
iso2: jm
iso3: jam
name: Jamaica
type: Country
- id: '659'
iso2: kn
iso3: kna
name: Saint Kitts And Nevis
type: Country
- id: '662'
iso2: lc
iso3: lca
name: Saint Lucia
type: Country
- id: '663'
iso2: mf
iso3: maf
name: Saint Martin
type: Country
- id: '484'
iso2: mx
iso3: mex
name: Mexico
type: Country
- id: '500'
iso2: ms
iso3: msr
name: Montserrat
type: Country
- id: '474'
iso2: mq
iso3: mtq
name: Martinique
type: Country
- id: '558'
iso2: ni
iso3: nic
name: Nicaragua
type: Country
- id: '591'
iso2: pa
iso3: pan
name: Panama
type: Country
- id: '630'
iso2: pr
iso3: pri
name: Puerto Rico
type: Country
- id: '222'
iso2: sv
iso3: slv
name: El Salvador
type: Country
- id: '666'
iso2: pm
iso3: spm
name: Saint Pierre And Miquelon
type: Country
- id: '534'
iso2: sx
iso3: sxm
name: Sint Maarten (Dutch part)
type: Country
- id: '796'
iso2: tc
iso3: tca
name: Turks And Caicos Islands
type: Country
- id: '780'
iso2: tt
iso3: tto
name: Trinidad and Tobago
type: Country
- id: '840'
iso2: us
iso3: usa
name: United States
type: Country
- id: '670'
iso2: vc
iso3: vct
name: Saint Vincent And The Grenadines
type: Country
- id: '92'
iso2: vg
iso3: vgb
name: British Virgin Islands
type: Country
- id: '850'
iso2: vi
iso3: vir
name: U.S. Virgin Islands
type: Country
id: '6'
links:
self: /fmc_config/v1/domain/DomainUUID/object/continents/6
name: North America
type: Continent
links:
self: /fmc_config/v1/domain/DomainUUID/object/continents?offset=0&limit=1
paging:
count: 7
limit: 1
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
offset: 0
pages: 7
schema:
$ref: '#/components/schemas/ContinentObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/continents/{objectId}:
get:
deprecated: false
description: '**Get the continent associated with the specified ID.**'
operationId: getContinentObject
parameters:
- description: Unique identifier of the continent.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/continents/2 ( Get continent object by id )':
value:
countries:
- id: '10'
iso2: aq
iso3: ata
name: Antarctica
type: Country
- id: '260'
iso2: tf
iso3: atf
name: French Southern Territories
type: Country
- id: '74'
iso2: bv
iso3: bvt
name: Bouvet Island
type: Country
id: '2'
links:
self: /fmc_config/v1/domain/DomainUUID/object/continents/2
name: Antarctica
type: Continent
schema:
$ref: '#/components/schemas/ContinentObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/countries:
get:
deprecated: false
description: '**Get the list of all countries.**'
operationId: getAllCountryObject
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/countries?limit=2 ( Get all paginated country objects
with limit set 2 )'
: value:
items:
- id: countryUUID
links:
self: /fmc_config/v1/domain/DomainUUID/object/countries/countryUUID
name: Aruba
type: Country
- id: country2UUID
links:
self: /fmc_config/v1/domain/DomainUUID/object/countries/country2UUID
name: Anguilla
type: Country
links:
self: /fmc_config/v1/domain/DomainUUID/object/countries?offset=0&limit=2
paging:
count: 252
limit: 2
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
offset: 0
pages: 126
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/countries?limit=2&expanded=true ( Get all paginated
country objects with limit set 2 )'
: value:
items:
- id: countryUUID
iso2: aw
iso3: abw
links:
self: /fmc_config/v1/domain/DomainUUID/object/countries/countryUUID
name: Aruba
type: Country
- id: country2UUID
iso2: ai
iso3: aia
links:
self: /fmc_config/v1/domain/DomainUUID/object/countries/country2UUID
name: Anguilla
type: Country
links:
self: /fmc_config/v1/domain/DomainUUID/object/countries?offset=0&limit=2
paging:
count: 252
limit: 2
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
offset: 0
pages: 126
schema:
$ref: '#/components/schemas/CountryObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/countries/{objectId}:
get:
deprecated: false
description: '**Get the country associated with the specified ID.**'
operationId: getCountryObject
parameters:
- description: Unique identifier of the country.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/countries/countryUUID ( Get country object by id )':
value:
id: countryUUID
iso2: aw
iso3: abw
links:
self: /fmc_config/v1/domain/DomainUUID/object/countries/countryUUID
name: Aruba
type: Country
schema:
$ref: '#/components/schemas/CountryObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/customsiiplistdownload/{objectId}:
get:
deprecated: false
description: '**Get the custom Security Intelligence IP List with the specified UUID.**'
operationId: getCustomSIIPListDownload
parameters:
- description: Unique identifier of the custom Security Intelligence IP List.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/customsiiplistdownload/{objectId} ( GET HTTP download
of custom Security Intelligence IP List using the provided object id. )'
: value: {}
schema:
$ref: '#/components/schemas/CustomSIIPListDownload'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/customsiiplists:
get:
deprecated: false
description: '**Get the list of all custom Security Intelligence Network List**'
operationId: getAllCustomSIIPList
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/customsiiplists?expanded=false&limit=2 ( Get all
paginated security intelligence Network lists with expanded set to false and limit set to 2 )'
: value:
items:
- id: 7ebc2fc6-97e3-11ed-8e55-39813451a4e3
links:
self: https://s45s01v046-vrouter.cisco.com:8001/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/customsiiplists/7ebc2fc6-97e3-11ed-8e55-39813451a4e3
name: network-list
type: CustomSIIPListObject
- id: 1575bf12-97d1-11ed-bf99-3d813451a4e3
links:
self: https://s45s01v046-vrouter.cisco.com:8001/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/customsiiplists/1575bf12-97d1-11ed-bf99-3d813451a4e3
name: network-list2
type: CustomSIIPListObject
links:
self: https://s45s01v046-vrouter.cisco.com:8001/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/customsiiplists?offset=0&limit=2&expanded=false
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/customsiiplists?expanded=true&limit=2 ( Get all
paginated security intelligence Network lists with expanded set to true and limit set to 2 )'
: value:
items:
- fileName: ip.txt
id: 1575bf12-97d1-11ed-bf99-3d813451a4e3
links:
self: https://s45s01v046-vrouter.cisco.com:8001/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/customsiiplists/1575bf12-97d1-11ed-bf99-3d813451a4e3
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
entryCount: 1
lastUser:
id: 68d03c42-d9bd-11dc-89f2-b7961d42c462
name: admin
type: user
readOnly:
state: false
timestamp: 1674115979.0
name: network-list2
type: CustomSIIPListObject
- fileName: ip.txt
id: 7ebc2fc6-97e3-11ed-8e55-39813451a4e3
links:
self: https://s45s01v046-vrouter.cisco.com:8001/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/customsiiplists/7ebc2fc6-97e3-11ed-8e55-39813451a4e3
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
entryCount: 1
lastUser:
id: 68d03c42-d9bd-11dc-89f2-b7961d42c462
name: admin
type: user
readOnly:
state: false
timestamp: 1674123886.0
name: network-list
type: CustomSIIPListObject
links:
self: https://s45s01v046-vrouter.cisco.com:8001/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/customsiiplists?offset=0&limit=2&expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/CustomSIIPListListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a custom Security Intelligence Network List. _Check the response section for applicable examples
(if any)._**'
operationId: createCustomSIIPList
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
multipart/form-data:
schema:
properties:
name:
description: Name of the custom Security Intelligence Network List object. *required
type: string
payloadFile:
description: Select a plain text list file. *required
format: binary
type: string
validateOnly:
description: Validate the uploaded list file only. By default is set to false.
type: boolean
type: object
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/customsiiplists ( Success: Test POST success of
a custom security intelligence Network list )'
: value:
fileName: ip.txt
id: 7ebc2fc6-97e3-11ed-8e55-39813451a4e3
links:
self: https://s45s01v046-vrouter.cisco.com:8001/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/customsiiplists/7ebc2fc6-97e3-11ed-8e55-39813451a4e3
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
entryCount: 1
invalidEntryCount: 0
lastUser:
id: 68d03c42-d9bd-11dc-89f2-b7961d42c462
name: admin
type: user
readOnly:
state: false
timestamp: 1674123886.0
totalEntryCount: 1
name: network-list
type: CustomSIIPListObject
version: 6.0.1
schema:
$ref: '#/components/schemas/CustomSIIPList'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/customsiiplists/{objectId}:
delete:
deprecated: false
description: '**Delete the custom Security Intelligence Network List associated with the specified ID. _Check the response
section for applicable examples (if any)._**'
operationId: deleteCustomSIIPList
parameters:
- description: Unique identifier of the custom Security Intelligence Network List.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/object/customsiiplists/1575bf12-97d1-11ed-bf99-3d813451a4e3
( Success: Test DELETE success of a custom security intelligence Network list )'
: value:
fileName: ip.txt
id: 1575bf12-97d1-11ed-bf99-3d813451a4e3
links:
self: https://s45s01v046-vrouter.cisco.com:8001/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/customsiiplists/1575bf12-97d1-11ed-bf99-3d813451a4e3
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
entryCount: 1
lastUser:
id: 68d03c42-d9bd-11dc-89f2-b7961d42c462
name: admin
type: user
readOnly:
state: false
timestamp: 1674115979.0
name: network-list2
type: CustomSIIPListObject
schema:
$ref: '#/components/schemas/CustomSIIPList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the custom Security Intelligence Network List associated with the specified ID.**'
operationId: getCustomSIIPList
parameters:
- description: Unique identifier of the custom Security Intelligence Network List.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/customsiiplists/7ebc2fc6-97e3-11ed-8e55-39813451a4e3
( Success: Test GET success of a custom security intelligence Network list )'
: value:
fileName: ip.txt
id: 7ebc2fc6-97e3-11ed-8e55-39813451a4e3
links:
self: https://s45s01v046-vrouter.cisco.com:8001/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/customsiiplists/7ebc2fc6-97e3-11ed-8e55-39813451a4e3
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
entryCount: 1
lastUser:
id: 68d03c42-d9bd-11dc-89f2-b7961d42c462
name: admin
type: user
readOnly:
state: false
timestamp: 1674123886.0
name: network-list
type: CustomSIIPListObject
schema:
$ref: '#/components/schemas/CustomSIIPList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the custom Security Intelligence Network List associated with the specified ID. _Check the response
section for applicable examples (if any)._**'
operationId: updateCustomSIIPList
parameters:
- description: Unique identifier of the custom Security Intelligence Network List.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
multipart/form-data:
schema:
properties:
id:
description: Unique identifier of the custom Security Intelligence Network List.
type: string
name:
description: Name of the custom Security Intelligence Network List object. *required
type: string
payloadFile:
description: Select a plain text list file. *required
format: binary
type: string
validateOnly:
description: Validate the uploaded list file only. By default is set to false.
type: boolean
type: object
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/customsiiplists/7ebc2fc6-97e3-11ed-8e55-39813451a4e3
( Success: Test PUT success of a custom security intelligence Network list )'
: value:
fileName: ip.txt
id: 7ebc2fc6-97e3-11ed-8e55-39813451a4e3
links:
self: https://s45s01v046-vrouter.cisco.com:8001/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/customsiiplists/7ebc2fc6-97e3-11ed-8e55-39813451a4e3
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
entryCount: 1
invalidEntryCount: 0
lastUser:
id: 68d03c42-d9bd-11dc-89f2-b7961d42c462
name: admin
type: user
readOnly:
state: false
timestamp: 1674124402.0
totalEntryCount: 1
name: network-list-updated
type: CustomSIIPListObject
version: 6.0.1
schema:
$ref: '#/components/schemas/CustomSIIPList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/customsiurllistdownload/{objectId}:
get:
deprecated: false
description: '**Get the custom Security Intelligence URL List with the specified UUID.**'
operationId: getCustomSIURLListDownload
parameters:
- description: Unique identifier of the custom Security Intelligence URL List.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/customsiurllistdownload/{objectId} ( GET HTTP download
of custom Security Intelligence URL List using the provided object id. )'
: value: {}
schema:
$ref: '#/components/schemas/CustomSIURLListDownload'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/customsiurllists:
get:
deprecated: false
description: '**Get the list of all custom Security Intelligence URL Lists.**'
operationId: getAllCustomSIURLList
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/customsiurllists?expanded=false&limit=2 ( Get all
paginated security intelligence URL lists with expanded set to false and limit set to 2 )'
: value:
items:
- id: 039c5244-9568-11ed-b64f-8b48d9209b4f
links:
self: /fmc_config/v1/domain/DomainUUID/object/customsiurllists/039c5244-9568-11ed-b64f-8b48d9209b4f
name: ABBA
type: CustomSIURLListObject
- id: 883029aa-9535-11ed-ab58-e346d9209b4f
links:
self: /fmc_config/v1/domain/DomainUUID/object/customsiurllists/883029aa-9535-11ed-ab58-e346d9209b4f
name: AABB
type: CustomSIURLListObject
links:
self: /fmc_config/v1/domain/DomainUUID/object/customsiurllists?expanded=false&offset=0&limit=2
paging:
count: 6
limit: 2
next:
- /fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=false&offset=2&limit=2
- /fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=false&offset=4&limit=2
offset: 0
pages: 3
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/customsiurllists?expanded=true&limit=2 ( Get all
paginated security intelligence URL lists with expanded set to true and limit set to 2 )'
: value:
items:
- fileName: file1
id: 039c5244-9568-11ed-b64f-8b48d9209b4f
links:
self: /fmc_config/v1/domain/DomainUUID/object/customsiurllists/039c5244-9568-11ed-b64f-8b48d9209b4f
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
entryCount: 36
lastUser:
id: 68d03c42-d9bd-11dc-89f2-b7961d42c462
name: admin
type: user
readOnly:
state: false
timestamp: 1673851723.0
name: ABBA
type: CustomSIURLListObject
- fileName: file2
id: 883029aa-9535-11ed-ab58-e346d9209b4f
links:
self: /fmc_config/v1/domain/DomainUUID/object/customsiurllists/883029aa-9535-11ed-ab58-e346d9209b4f
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
entryCount: 36
lastUser:
id: 68d03c42-d9bd-11dc-89f2-b7961d42c462
name: admin
type: user
readOnly:
state: false
timestamp: 1673738838.0
name: AABB
type: CustomSIURLListObject
links:
self: /fmc_config/v1/domain/DomainUUID/object/customsiurllists?expanded=true&offset=0&limit=2
paging:
count: 6
limit: 2
next:
- /fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=true&offset=2&limit=2
- /fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=true&offset=4&limit=2
offset: 0
pages: 3
schema:
$ref: '#/components/schemas/CustomSIURLListListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a custom Security Intelligence URL List. _Check the response section for applicable examples
(if any)._**'
operationId: createCustomSIURLList
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
multipart/form-data:
schema:
properties:
name:
description: Name of the custom Security Intelligence URL List object. *required
type: string
payloadFile:
description: Select a plain text list file. *required
format: binary
type: string
validateOnly:
description: Validate the uploaded list file only. By default is set to false.
type: boolean
type: object
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/customsiurllists ( Success: Test POST success
of a custom security intelligence URL list )'
: value:
fileName: file1
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
entryCount: 10
invalidEntryCount: 0
lastUser:
id: 68d03c42-d9bd-11dc-89f2-b7961d42c462
name: admin
type: user
readOnly:
state: false
timestamp: 1673851723.0
totalEntryCount: 10
name: ABBA
type: CustomSIURLListObject
version: 6.0.1
schema:
$ref: '#/components/schemas/CustomSIURLList'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/customsiurllists/{objectId}:
delete:
deprecated: false
description: '**Delete the custom Security Intelligence URL List associated with the specified ID. _Check the response
section for applicable examples (if any)._**'
operationId: deleteCustomSIURLList
parameters:
- description: Unique identifier of the custom Security Intelligence URL List.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/object/customsiurllists/039c5244-9568-11ed-b64f-8b48d9209b4f
( Success: Test DELETE success of a custom security intelligence URL list )'
: value:
fileName: file1
id: 039c5244-9568-11ed-b64f-8b48d9209b4f
links:
self: /fmc_config/v1/domain/DomainUUID/object/customsiurllists/039c5244-9568-11ed-b64f-8b48d9209b4f
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
entryCount: 36
lastUser:
id: 68d03c42-d9bd-11dc-89f2-b7961d42c462
name: admin
type: user
readOnly:
state: false
timestamp: 1673851723.0
name: ABBA
type: CustomSIURLListObject
schema:
$ref: '#/components/schemas/CustomSIURLList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the custom Security Intelligence URL List associated with the specified ID.**'
operationId: getCustomSIURLList
parameters:
- description: Unique identifier of the custom Security Intelligence URL List.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/customsiurllists/039c5244-9568-11ed-b64f-8b48d9209b4f
( Success: Test GET success of a custom security intelligence URL list )'
: value:
fileName: file1
id: 039c5244-9568-11ed-b64f-8b48d9209b4f
links:
self: /fmc_config/v1/domain/DomainUUID/object/customsiurllists/039c5244-9568-11ed-b64f-8b48d9209b4f
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
entryCount: 36
lastUser:
id: 68d03c42-d9bd-11dc-89f2-b7961d42c462
name: admin
type: user
readOnly:
state: false
timestamp: 1673851723.0
name: ABBA
type: CustomSIURLListObject
schema:
$ref: '#/components/schemas/CustomSIURLList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the custom Security Intelligence URL List associated with the specified ID. _Check the response
section for applicable examples (if any)._**'
operationId: updateCustomSIURLList
parameters:
- description: Unique identifier of the custom Security Intelligence URL List.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
multipart/form-data:
schema:
properties:
id:
description: Unique identifier of the custom Security Intelligence URL List.
type: string
name:
description: Name of the custom Security Intelligence URL List object. *required
type: string
payloadFile:
description: Select a plain text list file. *required
format: binary
type: string
validateOnly:
description: Validate the uploaded list file only. By default is set to false.
type: boolean
type: object
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/customsiurllists/039c5244-9568-11ed-b64f-8b48d9209b4f
( Success: Test PUT success of a custom security intelligence URL list )'
: value:
fileName: file1
id: 039c5244-9568-11ed-b64f-8b48d9209b4f
links:
self: /fmc_config/v1/domain/DomainUUID/object/customsiurllists/039c5244-9568-11ed-b64f-8b48d9209b4f
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
entryCount: 10
invalidEntryCount: 0
lastUser:
id: 68d03c42-d9bd-11dc-89f2-b7961d42c462
name: admin
type: user
readOnly:
state: false
timestamp: 1673851723.0
totalEntryCount: 10
name: ABBA
type: CustomSIURLListObject
version: 6.0.1
schema:
$ref: '#/components/schemas/CustomSIURLList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/dhcpipv6pools:
get:
deprecated: false
description: '**Get the list of all DHCP IPv6 pools.**'
operationId: getAllDHCPIPv6Pool
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DHCPIPv6PoolListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a DHCP IPv6 pool. _Check the response section for applicable examples (if any)._**'
operationId: createDHCPIPv6Pool
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DHCPIPv6Pool'
type: object
description: Input representation of DHCP IPv6 pool object.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DHCPIPv6Pool'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/dhcpipv6pools/{objectId}:
delete:
deprecated: false
description: '**Get the DHCP IPv6 pool associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteDHCPIPv6Pool
parameters:
- description: Unique identifier of the DHCP IPv6 pool.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DHCPIPv6Pool'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the DHCP IPv6 pool associated with the specified ID.**'
operationId: getDHCPIPv6Pool
parameters:
- description: Unique identifier of the DHCP IPv6 pool.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DHCPIPv6Pool'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the DHCP IPv6 pool associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateDHCPIPv6Pool
parameters:
- description: Unique identifier of the DHCP IPv6 pool.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DHCPIPv6Pool'
type: object
description: Input representation of DHCP IPv6 pool object.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DHCPIPv6Pool'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/distinguishednamegroups:
get:
deprecated: false
description: '**Get the list of all Distinguished Name groups.**'
operationId: getDistinguishedNameGroup
parameters:
- description: Name of the Distinguished Name Group.
in: query
name: filter
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/distinguishednamegroups?limit=2 ( Get all distinguished
name groups with limit set to 2 )'
: value:
items:
- id: 56d71648-91f6-47d3-b3f3-f92148089cd0
name: Cisco-Undecryptable-Sites
type: DistinguishedNameGroup
- id: 5cd4b2ee-079b-11ed-8362-8c025e25d4b4
name: wqrew
type: DistinguishedNameGroup
links:
self: https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednamegroups?offset=0&limit=25
paging:
count: 2
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/DistinguishedNameGroupListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/distinguishednames:
get:
deprecated: false
description: '**Get Distinguished Names.**'
operationId: getDistinguishedName
parameters:
- description: Name of the Distinguished Name.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/distinguishednames?limit=2 ( Get all distinguished
names with limit set to 2 )'
: value:
items:
- id: 7fa4067e-62f2-3ed7-9d38-f3bde65f7e50
name: CN_time-ios.apple.com
type: DistinguishedName
- id: 42fd2ace-8ea7-3972-9cfb-a9a8d561a92f
name: CN_ocsp.entrust.net
type: DistinguishedName
links:
self: https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=0&limit=2
paging:
count: 69
limit: 2
next:
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=2&limit=2
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=4&limit=2
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=6&limit=2
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=8&limit=2
offset: 0
pages: 35
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/distinguishednames?limit=2&expanded=true ( Get
all distinguished names with limit set to 2 and expanded set to true )'
: value:
items:
- dn: C=AB,CN=aBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
id: d136af2c-06cc-11ed-947f-06334677d29c
name: test2
type: DistinguishedName
- dn: CN=crl4.digicert.com
id: 09e148dc-c6b4-3821-8c57-45c72f93e860
name: CN_crl4.digicert.com
type: DistinguishedName
links:
self: https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=0&limit=2&expanded=true
paging:
count: 69
limit: 2
next:
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=2&limit=2&expanded=true
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=4&limit=2&expanded=true
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=6&limit=2&expanded=true
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=8&limit=2&expanded=true
offset: 0
pages: 35
schema:
$ref: '#/components/schemas/DistinguishedNameListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a Distinguished Name. _Check the response section for applicable examples (if any)._**'
operationId: createDistinguishedName
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/distinguishednames ( Test distinguished name creation )':
value:
dn: CN=intranet.sourcefire.com, C=US, O=Sourcefire, Inc., OU=SNI
name: test3
schema:
$ref: '#/components/schemas/DistinguishedName'
type: object
description: The input distinguished name object model.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/distinguishednames ( Test distinguished name creation )':
value:
dn: C=US,CN=intranet.sourcefire.com,O=Sourcefire Inc.,OU=SNI
id: a489286c-06cf-11ed-9330-05334677d29c
name: test3
type: DistinguishedName
schema:
$ref: '#/components/schemas/DistinguishedName'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/dnsservergroups:
get:
deprecated: false
description: '**Get the list of all DNS Server Groups.**'
operationId: getAllDNSServerGroupObject
parameters:
- description: Get the override(s) associated with the object on given target ID.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups ( Get all paginated DNS Server Group objects )':
value:
items:
- id: DNSServerGroupObjectUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID
name: DNSServerGroupObjectName1
type: DNSServerGroupObject
- id: DNSServerGroupObjectUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID
name: DNSServerGroupObjectName2
type: DNSServerGroupObject
- id: DNSServerGroupObjectUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID
name: DNSServerGroupObjectName3
type: DNSServerGroupObject
links:
self: api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups?offset=0&limit=3
paging:
count: 3
limit: 3
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups?expanded=true ( Get all paginated
DNS Server Group objects )'
: value:
items:
- defaultdomain: cisco.com
dnsservers:
- name-server: IPv4/IPv6hostaddress1
- name-server: IPv4/IPv6hostaddress2
id: DNSServerGroupObjectUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1524118335170.0
name: DNSServerGroupObjectName1
retries: 2
timeout: 2
type: DNSServerGroupObject
- defaultdomain: cisco.com
dnsservers:
- name-server: IPv4/IPv6hostaddress1
- name-server: IPv4/IPv6hostaddress2
id: DNSServerGroupObjectUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1523597066886.0
name: DNSServerGroupObjectName2
retries: 1
timeout: 1
type: DNSServerGroupObject
- defaultdomain: cisco.com
dnsservers:
- name-server: IPv4/IPv6hostaddress1
- name-server: IPv4/IPv6hostaddress2
id: DNSServerGroupObjectUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1524118310520.0
name: DNSServerGroupObjectName3
retries: 2
timeout: 2
type: DNSServerGroupObject
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups?offset=0&limit=3&expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/DNSServerGroupObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a list of all DNS Server Group. _Check the response section for applicable examples (if any)._**'
operationId: createDNSServerGroupObject
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups ( POST method for DNS Server Group Object )':
value:
defaultdomain: txcisco.com
dnsservers:
- name-server: IPv4/IPv6hostaddress1
- name-server: IPv4/IPv6hostaddress2
- name-server: IPv4/IPv6hostaddress3
- name-server: IPv4/IPv6hostaddress4
- name-server: IPv4/IPv6hostaddress5
- name-server: IPv4/IPv6hostaddress6
name: DNSServerGroupObjectName1
retries: 3
timeout: 3
type: DNSServerGroupObject
schema:
$ref: '#/components/schemas/DNSServerGroupObject'
type: object
description: Input representation of DNS Server Group object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups ( POST method for DNS Server Group Object )':
value:
defaultdomain: txcisco.com
dnsservers:
- name-server: IPv4/IPv6hostaddress1
- name-server: IPv4/IPv6hostaddress2
- name-server: IPv4/IPv6hostaddress3
- name-server: IPv4/IPv6hostaddress4
- name-server: IPv4/IPv6hostaddress5
- name-server: IPv4/IPv6hostaddress6
id: DNSServerGroupObjectUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 0
name: DNSServerGroupObjectName1
retries: 3
timeout: 3
type: DNSServerGroupObject
schema:
$ref: '#/components/schemas/DNSServerGroupObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/dnsservergroups/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all overrides on the DNS Server Group. Response will always be in expanded form. If passed, the
"expanded" query parameter will be ignored.**'
operationId: getAllDNSServerGroupOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/dnsservergroups/dnsservergroupUUID/overrides (
Get all paginated DNSServerGroup object overrides )'
: value:
items:
- defaultdomain: internal.cisco.com
dnsservers:
- name-server: 192.168.1.21
- name-server: 10.10.27.21
id: dnsservergroupUUID
links:
self: /fmc_config/v1/domain/domainUUID/object/dnsservergroups/dnsservergroupUUID?overrideTargetId=targetUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1596612383480.0
name: dns1
overridable: true
overrides:
parent:
id: dnsservergroupUUID
type: DNSServerGroupObject
target:
id: targetUUID
name: 10.10.27.28
type: Device
retries: 2
timeout: 2
type: DNSServerGroupObject
links:
self: /fmc_config/v1/domain/domainUUID/object/dnsservergroups/dnsservergroupUUID/overrides?offset=0&limit=2
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/DNSServerGroupOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/dnsservergroups/{containerUUID}/overrides/{objectId}:
get:
deprecated: false
description: '**Get the specified override for the DNS Server Group. Response will always be in expanded form. If passed,
the "expanded" query parameter will be ignored.**'
operationId: getDNSServerGroupOverride
parameters:
- description: Identifier for the DNS Server Group Override.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DNSServerGroupOverride'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/dnsservergroups/{objectId}:
delete:
deprecated: false
description: '**Delete the the DNS Server Group associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteDNSServerGroupObject
parameters:
- description: Identifier for the DNS Server Group.
in: path
name: objectId
required: true
schema:
type: string
- description: Get the override(s) associated with the object on given target ID.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID
( DELETE method for DNS Server Group Object )'
: value:
defaultdomain: cisco.com
dnsservers:
- name-server: IPv4/IPv6hostaddress1
- name-server: IPv4/IPv6hostaddress2
id: DNSServerGroupObjectUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1524129145233.0
name: DNSServerGroupObjectName1
retries: 1
timeout: 1
type: DNSServerGroupObject
schema:
$ref: '#/components/schemas/DNSServerGroupObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the DNS Server Group associated with the specified ID.**'
operationId: getDNSServerGroupObject
parameters:
- description: Identifier for the DNS Server Group.
in: path
name: objectId
required: true
schema:
type: string
- description: Get the override(s) associated with the object on given target ID.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID (
Get DNS Server Group object by id )'
: value:
defaultdomain: cisco.com
dnsservers:
- name-server: IPv4/IPv6hostaddress1
- name-server: IPv4/IPv6hostaddress2
id: DNSServerGroupObjectUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1523597066886.0
name: DNSServerGroupObjectName1
retries: 1
timeout: 1
type: DNSServerGroupObject
schema:
$ref: '#/components/schemas/DNSServerGroupObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the the DNS Server Group associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateDNSServerGroupObject
parameters:
- description: Identifier for the DNS Server Group.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID ( PUT
method for DNS Server Group Object )'
: value:
defaultdomain: cisco.com
dnsservers:
- name-server: IPv4/IPv6hostaddress1
- name-server: IPv4/IPv6hostaddress2
id: DNSServerGroupObjectUUID
name: DNSServerGroupObjectName1
retries: 1
timeout: 1
type: DNSServerGroupObject
schema:
$ref: '#/components/schemas/DNSServerGroupObject'
type: object
description: Input representation of DNS Server Group object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID (
PUT method for DNS Server Group Object )'
: value:
defaultdomain: cisco.com
dnsservers:
- name-server: IPv4/IPv6hostaddress1
- name-server: IPv4/IPv6hostaddress2
id: DNSServerGroupObjectUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/dnsservergroups/DNSServerGroupObjectUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 0
name: DNSServerGroupObjectName1
retries: 1
timeout: 1
type: DNSServerGroupObject
schema:
$ref: '#/components/schemas/DNSServerGroupObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/downloadinternalca:
post:
deprecated: false
description: '**Get and download the Internal Certificate Authority object in a PKCS12 file encrypted using the provided
password. _Check the response section for applicable examples (if any)._**'
operationId: createDownloadInternalCA
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/downloadinternalca ( POST download internal CA request. )':
value:
id: 31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
password: password
schema:
$ref: '#/components/schemas/DownloadInternalCA'
type: object
description: The input Download Internal CA model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DownloadInternalCA'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjectmappings:
delete:
deprecated: false
description: '**Remove Dynamic Object Mappings for specific Dynamic Objects. _Check the response section for applicable
examples (if any)._**'
operationId: deleteMultipleDynamicObjectMappingsBulk
parameters:
- description: 'Specify filter criteria- Object with ids:
"ids:id1,id2,..." - Unused objects:
"unusedOnly:true" - Name starts with:
"nameStartsWith:{name-pattern}" - Agent
ID:
"agentId:{Agent ID}"
'
in: query
name: filter
required: false
schema:
type: string
- description: Enables bulk removal of mappings
in: query
name: bulk
required: true
schema:
type: boolean
- description: Boolean value indicating whether to propagate dynamic object mappings. Default value is TRUE.
in: query
name: propagate
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DynamicObjectMappingsBulk'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Add Dynamic Object Mappings for specific Dynamic Objects. _Check the response section for applicable
examples (if any)._**'
operationId: createDynamicObjectMappingsBulk
parameters:
- description: Boolean value indicating whether to propagate dynamic object mappings. Default value is TRUE.
in: query
name: propagate
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjectmappings ( POST Dynamic Object Mappings Bulk )':
value:
add:
- dynamicObject:
id: 005056AB-931D-0ed3-0000-004294967373
name: Marketing
type: DynamicObject
mappings:
- 192.168.1.1
- 192.168.2.1
- dynamicObject:
id: 005056AB-931D-0ed3-0000-004294967391
name: IP
type: DynamicObject
mappings:
- 192.168.100.1
- 192.168.200.1
remove:
- dynamicObject:
id: 005056AB-931D-0ed3-0000-004294967391
name: IP
type: DynamicObject
mappings:
- 0.0.0.0
schema:
$ref: '#/components/schemas/DynamicObjectMappingsBulk'
type: object
description: Input representation of Dynamic Object Mappings Bulk Object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjectmappings ( POST Dynamic Object Mappings Bulk )':
value:
add:
- dynamicObject:
id: 005056AB-931D-0ed3-0000-004294967373
name: Marketing
type: DynamicObject
mappings:
- 192.168.1.1
- 192.168.2.1
- dynamicObject:
id: 005056AB-931D-0ed3-0000-004294967391
name: IP
type: DynamicObject
mappings:
- 192.168.100.1
- 192.168.200.1
remove:
- dynamicObject:
id: 005056AB-931D-0ed3-0000-004294967391
name: IP
type: DynamicObject
mappings:
- 0.0.0.0
schema:
$ref: '#/components/schemas/DynamicObjectMappingsBulk'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjects:
delete:
deprecated: false
description: '**Delete all Dynamic Objects. Filter to specify which Dynamic Objects will be deleted. _Check the response
section for applicable examples (if any)._**'
operationId: deleteMultipleDynamicObject
parameters:
- description: 'Specify filter criteria- Object with ids:
"ids:id1,id2,..." - Unused objects:
"unusedOnly:true" - Name starts with:
"nameStartsWith:{name-pattern}"
'
in: query
name: filter
required: false
schema:
type: string
- description: =Enables bulk delete of Dynamic Objects.
in: query
name: bulk
required: true
schema:
type: boolean
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects/dynamicobjectUUID ( DELETE
method for Dynamic Object )'
: value:
agentId: agent_007
description: IPs of marketing department
id: 005056AB-931D-0ed3-0000-004294967338
links:
self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects/005056AB-931D-0ed3-0000-004294967338
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
name: Marketing
objectType: IP
topicName: aws365
type: DynamicObject
schema:
$ref: '#/components/schemas/DynamicObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get list of all Dynamic Objects.**'
operationId: getAllDynamicObject
parameters:
- description: Only the Dynamic Objects matching with the specified name will be displayed. Cannot be used if object
ID is specified in path.
in: query
name: name
required: false
schema:
type: string
- description: Boolean indicating whether to add mappingsCount field to the metadata. Can be used if object ID is specified
in path.
in: query
name: includeCount
required: false
schema:
type: boolean
- description: 'Specify filter criteria- Object with ids:
"ids:id1,id2,..." - Unused objects:
"unusedOnly:true" - Name starts with:
"nameStartsWith:{name-pattern}"
'
in: query
name: filter
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects?expanded=true ( Get all paginated
Dynamic Objects )'
: value:
items:
- id: 0050568D-75AB-0ed3-0000-038654707195
links:
self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects/0050568D-75AB-0ed3-0000-038654707195
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
name: '11'
objectType: IP
type: DynamicObject
- id: 0050568D-75AB-0ed3-0000-038654707213
links:
self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects/0050568D-75AB-0ed3-0000-038654707213
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
name: '12'
objectType: IP
type: DynamicObject
- id: 0050568D-75AB-0ed3-0000-038654707231
links:
self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects/0050568D-75AB-0ed3-0000-038654707231
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
mappingsCount: 42
name: '13'
objectType: IP
type: DynamicObject
links:
self: api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects?expanded=true&offset=0&limit=3
paging:
count: '3'
limit: '3'
offset: '0'
pages: '1'
schema:
$ref: '#/components/schemas/DynamicObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a Dynamic Object. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleDynamicObject
parameters:
- description: =Enables bulk create of Dynamic Objects.
in: query
name: bulk
required: false
schema:
type: boolean
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects ( POST method for Dynamic Object )':
value:
agentId: agent_007
description: IPs of marketing department
name: Marketing
objectType: IP
topicName: aws365
type: DynamicObject
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects?bulk=true ( POST method for bulk
creation of Dynamic Objects )'
: value:
- agentId: agent_007
description: IPs of marketing department
name: Marketing
objectType: IP
topicName: aws365
type: DynamicObject
- agentId: agent_007
description: IPs of engineering department
name: Engineering
objectType: IP
topicName: aws365
type: DynamicObject
schema:
$ref: '#/components/schemas/DynamicObject'
type: object
description: Input representation of Dynamic Object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects ( POST method for Dynamic Object )':
value:
agentId: agent_007
description: IPs of marketing department
id: 005056AB-931D-0ed3-0000-004294967338
links:
self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects/005056AB-931D-0ed3-0000-004294967338
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
name: Marketing
objectType: IP
topicName: aws365
type: DynamicObject
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects?bulk=true ( POST method for
bulk creation of Dynamic Objects )'
: value:
items:
- agentId: agent_007
description: IPs of marketing department
id: 005056A9-4E43-0ed3-0000-128849018968
links:
self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects/005056A9-4E43-0ed3-0000-128849018968
name: Marketing
objectType: IP
topicName: aws365
type: DynamicObject
- agentId: agent_007
description: IPs of engineering department
id: 005056A9-4E43-0ed3-0000-128849018969
links:
self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects/005056A9-4E43-0ed3-0000-128849018969
name: Engineering
objectType: IP
topicName: aws365
type: DynamicObject
links:
self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects?bulk=true
schema:
$ref: '#/components/schemas/DynamicObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjects/{objectId}:
delete:
deprecated: false
description: '**Delete the Dynamic Object associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteDynamicObject
parameters:
- description: Identifier or name of the Dynamic Object.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects/dynamicobjectUUID ( DELETE
method for Dynamic Object )'
: value:
agentId: agent_007
description: IPs of marketing department
id: 005056AB-931D-0ed3-0000-004294967338
links:
self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects/005056AB-931D-0ed3-0000-004294967338
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
name: Marketing
objectType: IP
topicName: aws365
type: DynamicObject
schema:
$ref: '#/components/schemas/DynamicObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the Dynamic Object associated with the specified ID.**'
operationId: getDynamicObject
parameters:
- description: Identifier or name of the Dynamic Object.
in: path
name: objectId
required: true
schema:
type: string
- description: Boolean indicating whether to add mappingsCount field to the metadata. Can be used if object ID is specified
in path.
in: query
name: includeCount
required: false
schema:
type: boolean
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects/dynamicObjectUUID ( GET Dynamic Object by id )':
value:
description: Description of Dynamic Object
id: dynamicObjectUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/dynamicbjects/dynamicObjectUUID
metadata:
domain:
id: domainUUID
name: Global
type: Domain
lastUser:
id: userUUID
name: admin
type: User
name: Name of Dynamic Object
objectype: ip
type: DynamicObject
schema:
$ref: '#/components/schemas/DynamicObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the Dynamic Object associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateDynamicObject
parameters:
- description: Identifier or name of the Dynamic Object.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects/dynamicobjectUUID/ ( PUT method
for Dynamic Object )'
: value:
agentId: agent_007
description: IPs of marketing department changed
id: 005056AB-931D-0ed3-0000-004294967338
name: Marketing
objectType: IP
topicName: aws365
type: DynamicObject
schema:
$ref: '#/components/schemas/DynamicObject'
type: object
description: Input representation of Dynamic Object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects/dynamicobjectUUID/ ( PUT method
for Dynamic Object )'
: value:
agentId: agent_007
description: IPs of marketing department changed
id: 005056AB-931D-0ed3-0000-004294967338
links:
self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects/005056AB-931D-0ed3-0000-004294967338
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
name: Marketing
objectType: IP
topicName: aws365
type: DynamicObject
schema:
$ref: '#/components/schemas/DynamicObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjects/{objectId}/mappings:
get:
deprecated: false
description: '**Get the Dynamic Object Mappings associated with the specified ID.**'
operationId: getDynamicObjectMappings
parameters:
- description: Identifier or name of the Dynamic Object.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects/dynamicobjectUUID/mappings (
GET mappings for specific Dynamic Object )'
: value:
items:
- mapping: 1.1.1.1
- mapping: 1.1.1.4/24
- mapping: 1.1.3.4
- mapping: 1.2.2.1
schema:
$ref: '#/components/schemas/DynamicObjectMappingsListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the Dynamic Object Mappings associated with the specified ID. _Check the response section for
applicable examples (if any)._**'
operationId: updateDynamicObjectMappings
parameters:
- description: Identifier or name of the Dynamic Object.
in: path
name: objectId
required: true
schema:
type: string
- description: Specify action for dynamic object mappings. It can be one of ["add", "remove", "remove_all"]. Default
value is "add".
in: query
name: action
required: false
schema:
type: string
- description: Control propagating dynamic object mappings. It can be ["true", "false"]. Default value is "true".
in: query
name: propagate
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects/dynamicobjectUUID/mappings?action=add
( Add Dynamic Object Mappings )'
: value:
id: 0050568D-75AB-0ed3-0000-038654707195
mappings:
- 1.1.1.2
- 1.2.3.4/24
type: DynamicObjectMappings
? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects/dynamicobjectUUID/mappings?action=remove
( Add Dynamic Object Mappings )'
: value:
id: 0050568D-75AB-0ed3-0000-038654707195
mappings:
- 1.1.1.2
- 1.2.3.4/24
type: DynamicObjectMappings
? 'Example 3 : PUT /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects/dynamicobjectUUID/mappings?action=remove_all
( Add Dynamic Object Mappings )'
: value:
id: 0050568D-75AB-0ed3-0000-038654707195
type: DynamicObjectMappings
schema:
$ref: '#/components/schemas/DynamicObjectMappings'
type: object
description: The input dynamic object mappings model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects/dynamicobjectUUID/mappings?action=add
( Add Dynamic Object Mappings )'
: value:
id: 0050568D-75AB-0ed3-0000-038654707195
mappings:
- 1.1.1.2
- 1.2.3.4/24
type: DynamicObjectMappings
? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects/dynamicobjectUUID/mappings?action=remove
( Add Dynamic Object Mappings )'
: value:
id: 0050568D-75AB-0ed3-0000-038654707195
mappings:
- 1.1.1.2
- 1.2.3.4/24
type: DynamicObjectMappings
? 'Example 3 : PUT /api/fmc_config/v1/domain/DomainUUID/object/dynamicobjects/dynamicobjectUUID/mappings?action=remove_all
( Add Dynamic Object Mappings )'
: value:
id: 0050568D-75AB-0ed3-0000-038654707195
type: DynamicObjectMappings
schema:
$ref: '#/components/schemas/DynamicObjectMappings'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/endpointdevicetypes:
get:
deprecated: false
description: '**Get the list of all endpoint device types.**'
operationId: getAllEndPointDeviceType
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/exampledomainuuid/object/endpointdevicetypes ( Success: Test GET
ALL success of all Endpoint Device Types )'
: value:
items:
- id: exampleEndPointDeviceTypeuuid
links:
self: https://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/endpointdevicetypes/exampleEndPointDeviceTypeuuid
name: ExampleEndPointDeviceTypename
type: EndPointDeviceType
- id: exampleEndPointDeviceTypeuuid2
links:
self: https://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/endpointdevicetypes/exampleEndPointDeviceTypeuuid2
name: ExampleEndPointDeviceTypename2
type: EndPointDeviceType
links:
self: https://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/endpointdevicetypes?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/exampledomainuuid/object/endpointdevicetypes?expanded=true ( Success:
Test GET ALL success with expanded=true )'
: value:
items:
- description: example description.
fqName:
id: exampleEndPointDeviceTypeuuid
links:
self: https://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/endpointdevicetypes/exampleEndPointDeviceTypeuuid
metadata:
domain:
id: testdomainuuid
name: TestDomain
type: Domain
lastUser:
id: testuseruuid
name: testuser
type: User
readOnly:
state: true
timestamp: 41540695097.0
name: ExampleEndPointDeviceTypename
type: EndPointDeviceType
- description: example description.2
fqName:
id: exampleEndPointDeviceTypeuuid2
links:
self: https://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/endpointdevicetypes/exampleEndPointDeviceTypeuuid2
metadata:
domain:
id: testdomainuuid2
name: TestDomain2
type: Domain
lastUser:
id: testuseruuid2
name: testuser2
type: User
readOnly:
state: true
timestamp: 414393589.0
name: ExampleEndPointDeviceTypename2
type: EndPointDeviceType
links:
self: httpshttps://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/endpointdevicetypes?expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/EndPointDeviceTypeListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/endpointdevicetypes/{objectId}:
get:
deprecated: false
description: '**Get the endpoint device type associated with the specified ID.**'
operationId: getEndPointDeviceType
parameters:
- description: Unique identifier of the endpoint device type.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EndPointDeviceType'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/expandedcommunitylists:
get:
deprecated: false
description: '**Get the list of Expanded Community Lists.**'
operationId: getAllExpandedCommunityList
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/expandedcommunitylists ( Success: Test GET ALL success )':
value:
items:
- entries:
- action: PERMIT
regularExpression: '3456'
seqnumber: 1
type: Expanded
- action: DENY
regularExpression: '5678'
seqnumber: 2
type: Expanded
id: 00505681-3A7E-0ed3-0000-017179869236
links:
self: https://FMC-HOST/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/expandedcommunitylists/00505681-3A7E-0ed3-0000-017179869236
name: Exp
overridable: false
type: CommunityListObject
- entries:
- action: PERMIT
regularExpression: '986'
seqnumber: 1
type: Expanded
- action: DENY
regularExpression: '5643'
seqnumber: 2
type: Expanded
id: 00505681-3A7E-0ed3-0000-021474836503
links:
self: https://FMC-HOST/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/expandedcommunitylists/00505681-3A7E-0ed3-0000-021474836503
name: Exp2
overridable: false
type: CommunityListObject
links:
self: https://FMC-HOST/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/expandedcommunitylists?offset=0&limit=2&expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ExpandedCommunityListListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an Expanded Community List. _Check the response section for applicable examples (if any)._**'
operationId: createExpandedCommunityList
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExpandedCommunityList'
type: object
description: Payload representing Extended community list object.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpandedCommunityList'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/expandedcommunitylists/{objectId}:
delete:
deprecated: false
description: '**Delete the Expanded Community List associated with the specified ID. _Check the response section for
applicable examples (if any)._**'
operationId: deleteExpandedCommunityList
parameters:
- description: Unique identifier of the Expanded Community List.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpandedCommunityList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the Expanded Community List associated with the specified ID.**'
operationId: getExpandedCommunityList
parameters:
- description: Unique identifier of the Expanded Community List.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpandedCommunityList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the Expanded Community List associated with the specified ID. _Check the response section for
applicable examples (if any)._**'
operationId: updateExpandedCommunityList
parameters:
- description: Unique identifier of the Expanded Community List.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExpandedCommunityList'
type: object
description: Payload representing Extended community list object.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpandedCommunityList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists:
get:
deprecated: false
description: '**Get the list of Extended Access Lists.**'
operationId: getAllExtendedAccessListModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists ( Test GET All of ExtendedAccessList
Object )'
: value:
items:
- description: ' '
entries:
- action: PERMIT
destinationNetworks:
objects:
- id: 00000000-0000-0ed3-0000-270582939747
overridable: false
type: NetworkGroup
- id: 192c14f2-39d9-409d-81e9-357793bdf1ec
overridable: false
type: Network
logInterval: 545
logLevel: ERROR
logging: PER_ACCESS_LIST_ENTRY
sourceNetworks:
literals:
- type: Host
value: 1.1.1.1
- type: Host
value: 1.1.1.1/23
- type: Network
value: fe80::abcd/123
objects:
- id: 00000000-0000-0ed3-0000-257698037879
overridable: false
type: Host
- id: dde11d62-288b-4b4c-92e0-1dad0496f14b
overridable: false
type: Host
sourcePorts:
literals:
- port: '1521'
protocol: '17'
type: PortLiteral
- port: '12314'
protocol: '6'
type: PortLiteral
objects:
- id: 1834c674-38bb-11e2-86aa-62f0c593a59a
name: FTP
overridable: false
protocol: TCP
type: ProtocolPortObject
id: extACLObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists/extACLObjectUUID
name: ExtendedAccessListTest
overridable: false
type: ExtendedAccessList
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists?offset=0&limit=1&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ExtendedAccessListModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an Extended Access List. _Check the response section for applicable examples (if any)._**'
operationId: createExtendedAccessListModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists ( Test POST of ExtendedAccessList
Object )'
: value:
entries:
- action: PERMIT
destinationNetworks:
objects:
- id: 00000000-0000-0ed3-0000-270582939747
- id: 192c14f2-39d9-409d-81e9-357793bdf1ec
logInterval: 545
logLevel: ERROR
logging: PER_ACCESS_LIST_ENTRY
sourceNetworks:
literals:
- type: Host
value: 1.1.1.1
- type: Host
value: 1.1.1.1/23
- type: Network
value: fe80::abcd/123
objects:
- id: 00000000-0000-0ed3-0000-257698037879
- id: dde11d62-288b-4b4c-92e0-1dad0496f14b
sourcePorts:
literals:
- port: '1521'
protocol: '17'
type: PortLiteral
- port: '12314'
protocol: '6'
type: PortLiteral
objects:
- id: 1834c674-38bb-11e2-86aa-62f0c593a59a
name: ExtendedAccessListTest
schema:
$ref: '#/components/schemas/ExtendedAccessListModel'
type: object
description: Input representation of Extended Access List object.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists ( Test POST of ExtendedAccessList
Object )'
: value:
description: ' '
entries:
- action: PERMIT
destinationNetworks:
objects:
- id: 00000000-0000-0ed3-0000-270582939747
overridable: false
type: NetworkGroup
- id: 192c14f2-39d9-409d-81e9-357793bdf1ec
overridable: false
type: Network
logInterval: 545
logLevel: ERROR
logging: PER_ACCESS_LIST_ENTRY
sourceNetworks:
literals:
- type: Host
value: 1.1.1.1
- type: Host
value: 1.1.1.1/23
- type: Network
value: fe80::abcd/123
objects:
- id: 00000000-0000-0ed3-0000-257698037879
overridable: false
type: Host
- id: dde11d62-288b-4b4c-92e0-1dad0496f14b
overridable: false
type: Host
sourcePorts:
literals:
- port: '1521'
protocol: '17'
type: PortLiteral
- port: '12314'
protocol: '6'
type: PortLiteral
objects:
- id: 1834c674-38bb-11e2-86aa-62f0c593a59a
name: FTP
overridable: false
protocol: TCP
type: ProtocolPortObject
id: extACLObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists/extACLObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1622623643870.0
name: ExtendedAccessListTest
overridable: false
type: ExtendedAccessList
schema:
$ref: '#/components/schemas/ExtendedAccessListModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists/{objectId}:
delete:
deprecated: false
description: '**Delete the Extended Access associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteExtendedAccessListModel
parameters:
- description: Unique identifier of the Extended Access List.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists/{objectId} ( Test
DELETE of ExtendedAccessList Object )'
: value:
description: ' '
entries:
- action: PERMIT
destinationNetworks:
objects:
- id: 00000000-0000-0ed3-0000-270582939747
overridable: false
type: NetworkGroup
- id: 192c14f2-39d9-409d-81e9-357793bdf1ec
overridable: false
type: Network
logInterval: 300
logLevel: INFORMATIONAL
logging: DEFAULT
sourceNetworks:
literals:
- type: Host
value: 1.1.1.1
- type: Host
value: 1.1.1.1/23
- type: Network
value: fe80::abcd/123
objects:
- id: 00000000-0000-0ed3-0000-257698037879
overridable: false
type: Host
- id: dde11d62-288b-4b4c-92e0-1dad0496f14b
overridable: false
type: Host
id: extACLObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists/extACLObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1622625388110.0
name: ExtendedAccessListTest
overridable: false
type: ExtendedAccessList
schema:
$ref: '#/components/schemas/ExtendedAccessListModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the Extended Access List associated with the specified ID.**'
operationId: getExtendedAccessListModel
parameters:
- description: Unique identifier of the Extended Access List.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists/{objectId} ( Test GET
of ExtendedAccessList Object )'
: value:
description: ' '
entries:
- action: PERMIT
destinationNetworks:
objects:
- id: 00000000-0000-0ed3-0000-270582939747
overridable: false
type: NetworkGroup
- id: 192c14f2-39d9-409d-81e9-357793bdf1ec
overridable: false
type: Network
logInterval: 545
logLevel: ERROR
logging: PER_ACCESS_LIST_ENTRY
sourceNetworks:
literals:
- type: Host
value: 1.1.1.1
- type: Host
value: 1.1.1.1/23
- type: Network
value: fe80::abcd/123
objects:
- id: 00000000-0000-0ed3-0000-257698037879
overridable: false
type: Host
- id: dde11d62-288b-4b4c-92e0-1dad0496f14b
overridable: false
type: Host
sourcePorts:
literals:
- port: '1521'
protocol: '17'
type: PortLiteral
- port: '12314'
protocol: '6'
type: PortLiteral
objects:
- id: 1834c674-38bb-11e2-86aa-62f0c593a59a
name: FTP
overridable: false
protocol: TCP
type: ProtocolPortObject
id: extACLObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists/extACLObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1622623643870.0
name: ExtendedAccessListTest
overridable: false
type: ExtendedAccessList
schema:
$ref: '#/components/schemas/ExtendedAccessListModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the Extended Access associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateExtendedAccessListModel
parameters:
- description: Unique identifier of the Extended Access List.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists/{objectId} ( Test PUT of
ExtendedAccessList Object )'
: value:
entries:
- action: PERMIT
destinationNetworks:
objects:
- id: 00000000-0000-0ed3-0000-270582939747
- id: 192c14f2-39d9-409d-81e9-357793bdf1ec
logInterval: 300
logLevel: INFORMATIONAL
logging: DEFAULT
sourceNetworks:
literals:
- type: Host
value: 1.1.1.1
- type: Host
value: 1.1.1.1/23
- type: Network
value: fe80::abcd/123
objects:
- id: 00000000-0000-0ed3-0000-257698037879
- id: dde11d62-288b-4b4c-92e0-1dad0496f14b
id: extACLObjectUUID
name: ExtendedAccessListTest
schema:
$ref: '#/components/schemas/ExtendedAccessListModel'
type: object
description: Input representation of Extended Access List object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists/{objectId} ( Test PUT
of ExtendedAccessList Object )'
: value:
description: ' '
entries:
- action: PERMIT
destinationNetworks:
objects:
- id: 00000000-0000-0ed3-0000-270582939747
overridable: false
type: NetworkGroup
- id: 192c14f2-39d9-409d-81e9-357793bdf1ec
overridable: false
type: Network
logInterval: 300
logLevel: INFORMATIONAL
logging: DEFAULT
sourceNetworks:
literals:
- type: Host
value: 1.1.1.1
- type: Host
value: 1.1.1.1/23
- type: Network
value: fe80::abcd/123
objects:
- id: 00000000-0000-0ed3-0000-257698037879
overridable: false
type: Host
- id: dde11d62-288b-4b4c-92e0-1dad0496f14b
overridable: false
type: Host
id: extACLObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists/extACLObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 0
name: ExtendedAccessListTest
overridable: false
type: ExtendedAccessList
schema:
$ref: '#/components/schemas/ExtendedAccessListModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/extendedcommunitylists:
get:
deprecated: false
description: '**Get the list of all Extended Community Lists.**'
operationId: getAllExtendedCommunityList
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value and "type:{type}" to search for specific type of the object.For ExtendedCommunityLists
supported types are Standard and Expanded.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/extendedcommunitylists ( Get all paginated ExtendedCommunityList
Objects. )'
: value:
items:
- id: ExtendedCommunityListUUID1
links:
parent: /fmc_config/v1/domain/default/object/extendedcommunitylists
self: /fmc_config/v1/domain/default/object/object/extendedcommunitylists/00505686-7D42-0ed3-0000-352187318275
name: EXT_COM_1
type: ExtendedCommunityList
- id: ExtendedCommunityListUUID2
links:
parent: /fmc_config/v1/domain/default/object/extendedcommunitylists
self: /fmc_config/v1/domain/default/object/object/extendedcommunitylists/ExtendedCommunityListUUID1
name: EXT_COM_2
type: ExtendedCommunityList
links:
self: /fmc_config/v1/domain/DomainUUID/object/extendedcommunitylists?offset=0&limit=25
paging:
count: 2
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ExtendedCommunityListListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an Extended Community List. _Check the response section for applicable examples (if any)._**'
operationId: createExtendedCommunityList
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/extendedCommunityLists ( POST a Extended Community
List request. )'
: value:
entries:
- action: PERMIT|DENY
routeTarget|regularExpression: string
sequence: integer
name: string
subType: Expanded|Standard
type: ExtendedCommunityList
schema:
$ref: '#/components/schemas/ExtendedCommunityList'
type: object
description: Input representation of ExtendedCommunityList object.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedCommunityList'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/extendedcommunitylists/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all overrides on an Extended Community List. Response will always be in expanded form. If passed,
the "expanded" query parameter will be ignored.**'
operationId: getAllExtendedCommunityListOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/extendedcommunitylists/ExtendedCommunityListUUID/overrides
( Get all paginated ExtendedCommunityList objects )'
: value:
items:
- entries:
- action: PERMIT
routeTarget: '1:2'
sequence: '123'
id: ExtendedCommunityListUUID
links:
self: /fmc_config/v1/domain/domainUUID/object/extendedcommunitylists/ExtendedCommunityListUUID?overrideTargetId=targetUUID
metadata:
domain:
id: domainUUID
name: Global \ BENGALURU
lastUser:
name: user1
timestamp: 1520333477540.0
name: ABC
overridable: true
overrides:
parent:
id: ExtendedCommunityListUUID
type: ExtendedCommunityList
target:
id: domainUUID
name: Global \ BENGALURU
type: Domain
subType: Standard
type: ExtendedCommunityList
links:
self: /fmc_config/v1/domain/domainUUID/object/extendedcommunitylists/ExtendedCommunityListUUID/overrides?offset=0&limit=2
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ExtendedCommunityListOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/extendedcommunitylists/{containerUUID}/overrides/{objectId}:
get:
deprecated: false
description: '**Get the specified override on an Extended Community List.**'
operationId: getExtendedCommunityListOverride
parameters:
- description: Unique identifier of the Extended Community List Override.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedCommunityListOverride'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/extendedcommunitylists/{objectId}:
delete:
deprecated: false
description: '**Delete the Extended Community List associated with the specified ID. _Check the response section for
applicable examples (if any)._**'
operationId: deleteExtendedCommunityList
parameters:
- description: Unique identifier of the Extended Community List.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedCommunityList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the Extended Community List associated with the specified ID.**'
operationId: getExtendedCommunityList
parameters:
- description: Unique identifier of the Extended Community List.
in: path
name: objectId
required: true
schema:
type: string
- description: Get the overrides associated with the specified Extended Community List.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/extendedcommunitylists/ExtendedCommunityListUUID
( GET a ExtendedCommunityList Object for the given UUID )'
: value:
entries:
- action: DENY
regularExpression: test
sequence: 123
id: ExtendedCommunityListUUID
links:
parent: /fmc_config/v1/domain/default/object/extendedcommunitylists
self: /fmc_config/v1/domain/default/object/object/extendedcommunitylists/ExtendedCommunityListUUID
metadata:
domain:
id: GloablDomainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1613996238500.0
name: Ext_com
overridable: false
subType: Expanded
type: ExtendedCommunityList
schema:
$ref: '#/components/schemas/ExtendedCommunityList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the Extended Community List associated with the specified ID. _Check the response section for
applicable examples (if any)._**'
operationId: updateExtendedCommunityList
parameters:
- description: Unique identifier of the Extended Community List.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/extendedcommunitylists ( update a ExtendedCommunityList
Object for the given UUID. )'
: value:
entries:
- action: DENY
routeTarget: '1:2'
sequence: 123
id: ExtendedCommunityListUUID
name: EXT_COM_1
overridable: false
subType: Standard
type: ExtendedCommunityList
schema:
$ref: '#/components/schemas/ExtendedCommunityList'
type: object
description: Input representation of ExtendedCommunityList object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/extendedcommunitylists ( update a ExtendedCommunityList
Object for the given UUID. )'
: value:
entries:
- action: DENY
routeTarget: '1:2'
sequence: 123
id: ExtendedCommunityListUUID
links:
parent: /fmc_config/v1/domain/default/object/extendedcommunitylists
self: /fmc_config/v1/domain/DomainUUID/object/extendedcommunitylists/ExtendedCommunityListUUID1
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1613995959773.0
name: EXT_COM_1
overridable: false
subType: Standard
type: ExtendedCommunityList
schema:
$ref: '#/components/schemas/ExtendedCommunityList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/externalcacertificategroups:
get:
deprecated: false
description: '**Get the list of all trusted Certificate Authority groups.**'
operationId: getExternalCACertificateGroup
parameters:
- description: Filter by name of the trusted Certificate Authority group.
in: query
name: filter
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/trustedcagroups?limit=2 ( Get all trusted CA groups
with limit set to 2 )'
: value:
items:
- id: d3856136-b65c-49e6-ac4c-0daf5be98bc1
name: Cisco-Trusted-Authorities
type: ExternalCACertificateGroup
- id: 028ab73c-0162-11ed-b81d-bf48fe2f3341
name: group1
type: ExternalCACertificateGroup
links:
self: https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/trustedcagroups?offset=0&limit=2
paging:
count: 3
limit: 2
next:
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/trustedcagroups?offset=2&limit=1
offset: 0
pages: 2
schema:
$ref: '#/components/schemas/ExternalCACertificateGroupListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/externalcacertificates:
get:
deprecated: false
description: '**Get the list of trusted certificate authorities.**'
operationId: getExternalCACertificate
parameters:
- description: Filter by name of the trusted Certificate Authority.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/externalcacertificates?limit=2 ( Get all trusted
CAs with limit set to 2 )'
: value:
items:
- id: c333d857-4b7e-37bb-86c3-45eccebba982
name: Cisco-Root-CA-M2
type: ExternalCACertificate
- id: d88e803d-847f-3ad4-862e-3f11f7992b96
name: Amazon-Root-CA-3
type: ExternalCACertificate
links:
self: https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcacertificates?offset=0&limit=2&expanded=false
paging:
count: 105
limit: 2
next:
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcacertificates?offset=2&limit=2&expanded=false
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcacertificates?offset=4&limit=2&expanded=false
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcacertificates?offset=6&limit=2&expanded=false
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcacertificates?offset=8&limit=2&expanded=false
offset: 0
pages: 53
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/externalcacertificates?limit=2&expanded=true (
Get all trusted CAs with limit set to 2 and expanded set to true )'
: value:
items:
- cert: '-----BEGIN CERTIFICATE-----
MIIFkDCCA3igAwIBAgIQBZsbV56OITLiOQe9p3d1XDANBgkqhkiG9w0BAQwFADBi
MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3
d3cuZGlnaWNlcnQuY29tMSEwHwYDVQQDExhEaWdpQ2VydCBUcnVzdGVkIFJvb3Qg
RzQwHhcNMTMwODAxMTIwMDAwWhcNMzgwMTE1MTIwMDAwWjBiMQswCQYDVQQGEwJV
UzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cuZGlnaWNlcnQu
Y29tMSEwHwYDVQQDExhEaWdpQ2VydCBUcnVzdGVkIFJvb3QgRzQwggIiMA0GCSqG
SIb3DQEBAQUAA4ICDwAwggIKAoICAQC/5pBzaN675F1KPDAiMGkz7MKnJS7JIT3y
ithZwuEppz1Yq3aaza57G4QNxDAf8xukOBbrVsaXbR2rsnnyyhHS5F/WBTxSD1If
xp4VpX6+n6lXFllVcq9ok3DCsrp1mWpzMpTREEQQLt+C8weE5nQ7bXHiLQwb7iDV
ySAdYyktzuxeTsiT+CFhmzTrBcZe7FsavOvJz82sNEBfsXpm7nfISKhmV1efVFiO
DCu3T6cw2Vbuyntd463JT17lNecxy9qTXtyOj4DatpGYQJB5w3jHtrHEtWoYOAMQ
jdjUN6QuBX2I9YI+EJFwq1WCQTLX2wRzKm6RAXwhTNS8rhsDdV14Ztk6MUSaM0C/
CNdaSaTC5qmgZ92kJ7yhTzm1EVgX9yRcRo9k98FpiHaYdj1ZXUJ2h4mXaXpI8OCi
EhtmmnTK3kse5w5jrubU75KSOp493ADkRSWJtppEGSt+wJS00mFt6zPZxd9LBADM
fRyVw4/3IbKyEbe7f/LVjHAsQWCqsWMYRJUadmJ+9oCw++hkpjPRiQfhvbfmQ6QY
uKZ3AeEPlAwhHbJUKSWJbOUOUlFHdL4mrLZBdd56rF+NP8m800ERElvlEFDrMcXK
chYiCd98THU/Y+whX8QgUWtvsauGi0/C1kVfnSD8oR7FwI+isX4KJpn15GkvmB0t
9dmpsh3lGwIDAQABo0IwQDAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIB
hjAdBgNVHQ4EFgQU7NfjgtJxXWRM3y5nP+e6mK4cD08wDQYJKoZIhvcNAQEMBQAD
ggIBALth2X2pbL4XxJEbw6GiAI3jZGgPVs93rnD5/ZpKmbnJeFwMDF/k5hQpVgs2
SV1EY+CtnJYYZhsjDT156W1r1lT40jzBQ0CuHVD1UvyQO7uYmWlrx8GnqGikJ9yd
+SeuMIW59mdNOj6PWTkiU0TryF0Dyu1Qen1iIQqAyHNm0aAFYF/opbSnr6j3bTWc
fFqK1qI4mfN4i/RN0iAL3gTujJtHgXINwBQy7zBZLq7gcfJW5GqXb5JQbZaNaHqa
sjYUegbyJLkJEVDXCLG4iXqEI2FCKeWjzaIgQdfRnGTZ6iahixTXTBmyUEFxPT9N
cCOGDErcgdLMMpSEDQgJlxxPwO5rIHQw0uA5NBCFIRUBCOhVMt5xSdkoF1BN5r5N
0XWs0Mr7QbhDparTwwVETyw2m+L64kW4I1NsBm9nVX9GtUw/bihaeSbSpKhil9Ie
4u1Ki7wb/UdKDd9nZn6yW0HQO+T0O/QEY+nvwlQAUaCKKsnOeMzV6ocEGLPOr0mI
r/OSmbaz5mEP0oUA51Aa5BuVnRmhuZyxm7EAHu/QD09CbMkKvO5D+jpxpchNJqU1
/YldvIViHTLSoCtU7ZpXwdv6EM8Zt4tKG48BtieVU+i2iW1bvGjUI+iLUaJW+fCm
gKDWHrO8Dw9TdSmq6hN35N6MgSGtBxBHEa2HPQfRdbzP82Z+
-----END CERTIFICATE-----
'
certFingerprint: DD:FB:16:CD:49:31:C9:73:A2:03:7D:3F:C8:3A:4D:7D:77:5D:05:E4
crlSerials: []
id: ae6ceedc-b424-381c-b857-d97f22118424
issuerCommonName: DigiCert Trusted Root G4
issuerOrganization: DigiCert Inc
issuerOrganizationUnit: www.digicert.com
name: DigiCert-Trusted-Root-G4
publicKeyFingerprint: b49ce1b3508b83e64e4489e22c5d4c3655093c7b
serialNumber: 05:9b:1b:57:9e:8e:21:32:e2:39:07:bd:a7:77:75:5c
subjectCommonName: DigiCert Trusted Root G4
subjectOrganization: DigiCert Inc
subjectOrganizationUnit: www.digicert.com
type: ExternalCACertificate
validityEndDate: Jan 15 12:00:00 2038 GMT
validityStartDate: Aug 1 12:00:00 2013 GMT
- cert: '-----BEGIN CERTIFICATE-----
MIIDxTCCAq2gAwIBAgIQAqxcJmoLQJuPC3nyrkYldzANBgkqhkiG9w0BAQUFADBs
MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3
d3cuZGlnaWNlcnQuY29tMSswKQYDVQQDEyJEaWdpQ2VydCBIaWdoIEFzc3VyYW5j
ZSBFViBSb290IENBMB4XDTA2MTExMDAwMDAwMFoXDTMxMTExMDAwMDAwMFowbDEL
MAkGA1UEBhMCVVMxFTATBgNVBAoTDERpZ2lDZXJ0IEluYzEZMBcGA1UECxMQd3d3
LmRpZ2ljZXJ0LmNvbTErMCkGA1UEAxMiRGlnaUNlcnQgSGlnaCBBc3N1cmFuY2Ug
RVYgUm9vdCBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMbM5XPm
+9S75S0tMqbf5YE/yc0lSbZxKsPVlDRnogocsF9ppkCxxLeyj9CYpKlBWTrT3JTW
PNt0OKRKzE0lgvdKpVMSOO7zSW1xkX5jtqumX8OkhPhPYlG++MXs2ziS4wblCJEM
xChBVfvLWokVfnHoNb9Ncgk9vjo4UFt3MRuNs8ckRZqnrG0AFFoEt7oT61EKmEFB
Ik5lYYeBQVCmeVyJ3hlKV9Uu5l0cUyx+mM0aBhakaHPQNAQTXKFx01p8VdteZOE3
hzBWBOURtCmAEvF5OYiiAhF8J2a3iLd48soKqDirCmTCv2ZdlYTBoSUeh10aUAsg
EsxBu24LUTi4S8sCAwEAAaNjMGEwDgYDVR0PAQH/BAQDAgGGMA8GA1UdEwEB/wQF
MAMBAf8wHQYDVR0OBBYEFLE+w2kD+L9HAdSYJhoIAu9jZCvDMB8GA1UdIwQYMBaA
FLE+w2kD+L9HAdSYJhoIAu9jZCvDMA0GCSqGSIb3DQEBBQUAA4IBAQAcGgaX3Nec
nzyIZgYIVyHbIUf4KmeqvxgydkAQV8GK83rZEWWONfqe/EW1ntlMMUu4kehDLI6z
eM7b41N5cdblIZQB2lWHmiRk9opmzN6cN82oNLFpmyPInngiK3BD41VHMWEZ71jF
hS9OMPagMRYjyOfiZRYzy78aG6A9+MpeizGLYAiJLQwGXFK3xPkKmNEVX58Svnw2
Yzi9RKR/5CYrCsSXaQ3pjOLAEFe4yHYSkVXySGnYvCoCWw9E1CAx2/S6cCZdkGCe
vEsXCS+0yx5DaMkHJ8HSXPfqIbloEpw8nL+e/IBcm2PN7EeqJSdnoDfzAIJ9VNep
+OkuE6N36B9K
-----END CERTIFICATE-----
'
certFingerprint: 5F:B7:EE:06:33:E2:59:DB:AD:0C:4C:9A:E6:D3:8F:1A:61:C7:DC:25
crlSerials: []
id: 2aa05fb3-f5bc-3089-9a9e-1fa8d08859c1
issuerCommonName: DigiCert High Assurance EV Root CA
issuerOrganization: DigiCert Inc
issuerOrganizationUnit: www.digicert.com
name: DigiCert-High-Assurance-EV-Root-CA
publicKeyFingerprint: 627a4129a49877e0562a01fd38d319d42a34e036
serialNumber: 02:ac:5c:26:6a:0b:40:9b:8f:0b:79:f2:ae:46:25:77
subjectCommonName: DigiCert High Assurance EV Root CA
subjectOrganization: DigiCert Inc
subjectOrganizationUnit: www.digicert.com
type: ExternalCACertificate
validityEndDate: Nov 10 00:00:00 2031 GMT
validityStartDate: Nov 10 00:00:00 2006 GMT
links:
self: https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcacertificates?offset=0&limit=2&expanded=true
paging:
count: 105
limit: 2
next:
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcacertificates?offset=2&limit=2&expanded=true
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcacertificates?offset=4&limit=2&expanded=true
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcacertificates?offset=6&limit=2&expanded=true
- https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcacertificates?offset=8&limit=2&expanded=true
offset: 0
pages: 53
schema:
$ref: '#/components/schemas/ExternalCACertificateListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a trusted Certificate Authority. _Check the response section for applicable examples (if any)._**'
operationId: createExternalCACertificate
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/externalcacertificates ( Test trusted CA import
with certificate )'
: value:
cert: '-----BEGIN CERTIFICATE-----
MIIEHzCCAwegAwIBAgIUXTjDPsnWV+ig5NI0sDORuSY7wvYwDQYJKoZIhvcNAQEL
BQAwgZ4xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOVjESMBAGA1UEBwwJTGFzIFZl
Z2FzMRowGAYDVQQKDBFDaGFzZSBDb3Jwb3JhdGlvbjEcMBoGA1UECwwTZWNvbW1l
cmNlICwgZmluYW5jZTEWMBQGA1UEAwwNd3d3LmNoYXNlLmNvbTEcMBoGCSqGSIb3
DQEJARYNYWJjQGNoYXNlLmNvbTAeFw0xOTEyMTIyMjI5MTNaFw0yOTEyMDkyMjI5
MTNaMIGeMQswCQYDVQQGEwJVUzELMAkGA1UECAwCTlYxEjAQBgNVBAcMCUxhcyBW
ZWdhczEaMBgGA1UECgwRQ2hhc2UgQ29ycG9yYXRpb24xHDAaBgNVBAsME2Vjb21t
ZXJjZSAsIGZpbmFuY2UxFjAUBgNVBAMMDXd3dy5jaGFzZS5jb20xHDAaBgkqhkiG
9w0BCQEWDWFiY0BjaGFzZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK
AoIBAQCbMjm0qobAvVY4zxBEmqH5eADF+cdqFhr8iNW4B3EvR9M2A+WiHP/OY7if
6jn1c/c5T4uIbyELZ2Q/ESKd0z3NH5gPpilkLWxaaC+wkzWSfGctJy2UoddlDp0q
OfUwzPJP4hOKqaYChOH7wdcJCaykZ49lgbLDtJT9XsaeCIfb9AIk+Ujki8IjEfHj
84Fkk0wrlM58+ZdD6vZ+cNTuUaZy8SLnv6IiX9ML1pe4HPiB4a2R0bYYD7HBxIJu
QFqC2cBoKTITzRqJfz/xF7MGEmN+IGknj7uBDkCtY2/2+w0bBuIMExwO0CURVyR0
e9zLF+Ik0RUxFRUOjwvd5OA7bxujAgMBAAGjUzBRMB0GA1UdDgQWBBRqNcb0pcx7
u15+wGA4qgMlNUxfJTAfBgNVHSMEGDAWgBRqNcb0pcx7u15+wGA4qgMlNUxfJTAP
BgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQA0jBnsMAT8/X9UHO1y
+C6UNjtcOELiH3a5H+5WhYQ3jHEry2o//jDmFUI1/Sd9ZDTW8g+bU0vSz/PnAA8J
dyqzPJxfQUXrcuKrcX/msJbB3FRXkUlEKDSkDCo3gA5VuVLVTFdEm716lH9dERUx
5mBFTAsX18hnyD2e80e9DGnPhLvHJ7zps7WHsgBkWMhw3wJmZ7OvmCDSYqzeteSc
1X7P4mUCPJWLnUu1gax0rjWwLujaZ4b2ir/1ad1KfwYyoiUoA7bw2qTWbn5ljzFs
qD8QPtmp3108A2owIMO+TvVnjkP5wbFeND9ATuDghvm/uA49DA5pb68nyVQRHfpn
TsFC
-----END CERTIFICATE-----'
name: trusted_ca_1
schema:
$ref: '#/components/schemas/ExternalCACertificate'
type: object
description: Input representation of Trusted CA object.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/externalcacertificates ( Test trusted CA import
with certificate )'
: value:
cert: '-----BEGIN CERTIFICATE-----
MIIEHzCCAwegAwIBAgIUXTjDPsnWV+ig5NI0sDORuSY7wvYwDQYJKoZIhvcNAQEL
BQAwgZ4xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOVjESMBAGA1UEBwwJTGFzIFZl
Z2FzMRowGAYDVQQKDBFDaGFzZSBDb3Jwb3JhdGlvbjEcMBoGA1UECwwTZWNvbW1l
cmNlICwgZmluYW5jZTEWMBQGA1UEAwwNd3d3LmNoYXNlLmNvbTEcMBoGCSqGSIb3
DQEJARYNYWJjQGNoYXNlLmNvbTAeFw0xOTEyMTIyMjI5MTNaFw0yOTEyMDkyMjI5
MTNaMIGeMQswCQYDVQQGEwJVUzELMAkGA1UECAwCTlYxEjAQBgNVBAcMCUxhcyBW
ZWdhczEaMBgGA1UECgwRQ2hhc2UgQ29ycG9yYXRpb24xHDAaBgNVBAsME2Vjb21t
ZXJjZSAsIGZpbmFuY2UxFjAUBgNVBAMMDXd3dy5jaGFzZS5jb20xHDAaBgkqhkiG
9w0BCQEWDWFiY0BjaGFzZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK
AoIBAQCbMjm0qobAvVY4zxBEmqH5eADF+cdqFhr8iNW4B3EvR9M2A+WiHP/OY7if
6jn1c/c5T4uIbyELZ2Q/ESKd0z3NH5gPpilkLWxaaC+wkzWSfGctJy2UoddlDp0q
OfUwzPJP4hOKqaYChOH7wdcJCaykZ49lgbLDtJT9XsaeCIfb9AIk+Ujki8IjEfHj
84Fkk0wrlM58+ZdD6vZ+cNTuUaZy8SLnv6IiX9ML1pe4HPiB4a2R0bYYD7HBxIJu
QFqC2cBoKTITzRqJfz/xF7MGEmN+IGknj7uBDkCtY2/2+w0bBuIMExwO0CURVyR0
e9zLF+Ik0RUxFRUOjwvd5OA7bxujAgMBAAGjUzBRMB0GA1UdDgQWBBRqNcb0pcx7
u15+wGA4qgMlNUxfJTAfBgNVHSMEGDAWgBRqNcb0pcx7u15+wGA4qgMlNUxfJTAP
BgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQA0jBnsMAT8/X9UHO1y
+C6UNjtcOELiH3a5H+5WhYQ3jHEry2o//jDmFUI1/Sd9ZDTW8g+bU0vSz/PnAA8J
dyqzPJxfQUXrcuKrcX/msJbB3FRXkUlEKDSkDCo3gA5VuVLVTFdEm716lH9dERUx
5mBFTAsX18hnyD2e80e9DGnPhLvHJ7zps7WHsgBkWMhw3wJmZ7OvmCDSYqzeteSc
1X7P4mUCPJWLnUu1gax0rjWwLujaZ4b2ir/1ad1KfwYyoiUoA7bw2qTWbn5ljzFs
qD8QPtmp3108A2owIMO+TvVnjkP5wbFeND9ATuDghvm/uA49DA5pb68nyVQRHfpn
TsFC
-----END CERTIFICATE-----'
certFingerprint: D5:2E:64:1B:95:77:65:E6:F2:7D:09:D4:C5:ED:3F:98:99:4B:12:81
crlSerials: []
id: c8056876-ff0b-11ec-b1fe-6d1f4677d29c
issuerCommonName: www.chase.com
issuerOrganization: Chase Corporation
issuerOrganizationUnit: ecommerce
name: trusted_ca_1
publicKeyFingerprint: dbc7f674230336d43ca0e64fad3a4f46bb8c28c4
serialNumber: 5d:38:c3:3e:c9:d6:57:e8:a0:e4:d2:34:b0:33:91:b9:26:3b:c2:f6
subjectCommonName: www.chase.com
subjectOrganization: Chase Corporation
subjectOrganizationUnit: ecommerce
type: ExternalCACertificate
validityEndDate: Dec 9 22:29:13 2029 GMT
validityStartDate: Dec 12 22:29:13 2019 GMT
schema:
$ref: '#/components/schemas/ExternalCACertificate'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/externalcertificategroups:
get:
deprecated: false
description: '**Get the list of all external certificate groups.**'
operationId: getExternalCertificateGroup
parameters:
- description: Filter by name of the external certificate group.
in: query
name: filter
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/externalcertificategroups?limit=2 ( Get all external
certificate groups with limit set to 2 )'
: value:
items:
- id: 5ab98ade-0d18-11ed-aefa-fbeb515ffda9
name: external_cert_group_1
type: ExternalCertificateGroup
links:
self: https://172.29.182.90:10228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcertificategroups?offset=0&limit=25&filter=name:exter&expanded=false
paging:
count: 1
limit: 25
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/externalcertificategroups?limit=2&expanded=true
( Get all external certificate groups with limit set to 2 and expanded set to true )'
: value:
items:
- id: 5ab98ade-0d18-11ed-aefa-fbeb515ffda9
name: external_cert_group_1
objects:
- id: 43f07e84-0d18-11ed-aefa-fbeb515ffda9
name: external_cert_1
type: ExternalCertificate
type: ExternalCertificateGroup
links:
self: https://172.29.182.90:10228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcertificategroups?offset=0&limit=25&filter=name:exter&expanded=true
paging:
count: 1
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ExternalCertificateGroupListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/externalcertificates:
get:
deprecated: false
description: '**Get the list of external certificates.**'
operationId: getExternalCertificate
parameters:
- description: Filter by name of the certificate.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/externalcertificates?limit=2 ( Get all external
certificates with limit set to 2 )'
: value:
items:
- id: 3ec5aea6-0dff-11ed-8f01-77c97872e20b
name: abc
type: ExternalCertificate
- id: dca27b98-0dfc-11ed-a640-82917872e20b
name: external_cert_2
type: ExternalCertificate
links:
self: https://172.29.182.90:10228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcertificates?offset=0&limit=2
paging:
count: 3
limit: 2
next:
- https://172.29.182.90:10228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcertificates?offset=2&limit=1
offset: 0
pages: 2
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/externalcertificates?limit=2&expanded=true ( Get
all internal certificates with limit set to 2 and expanded set to true )'
: value:
items:
- cert: '-----BEGIN CERTIFICATE-----
MIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV
BAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE
ChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy
NDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3
MTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp
dHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs
MTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG
SIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg
x9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6
imwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt
8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC
sDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46
oYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0
dHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx
MDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT
FzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3
hGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko
42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu
rIuPFw==
-----END CERTIFICATE-----
'
certFingerprint: 50:9D:77:44:D4:A3:AC:3B:E1:F6:11:2E:85:19:15:0B:D0:D4:6B:D3
id: 43f07e84-0d18-11ed-aefa-fbeb515ffda9
issuerCommonName: internal1024.internal1024
issuerOrganization: Sourcefire
issuerOrganizationUnit: Development
name: external_cert_1
publicKeyFingerprint: 820bad9cae9c1ef9eb2cfea20ebbfe3fe2eb4521
serialNumber: fa:a5:5d:ae:66:34:13:17
subjectCommonName: internal1024.internal1024
subjectOrganization: Sourcefire
subjectOrganizationUnit: Development
type: ExternalCertificate
validityEndDate: '2025-03-07T15:45:51Z'
validityStartDate: '2015-03-10T15:45:51Z'
- cert: '-----BEGIN CERTIFICATE-----
MIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV
BAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE
ChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy
NDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3
MTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp
dHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs
MTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG
SIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg
x9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6
imwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt
8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC
sDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46
oYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0
dHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx
MDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT
FzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3
hGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko
42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu
rIuPFw==
-----END CERTIFICATE-----
'
certFingerprint: 50:9D:77:44:D4:A3:AC:3B:E1:F6:11:2E:85:19:15:0B:D0:D4:6B:D3
id: 3ec5aea6-0dff-11ed-8f01-77c97872e20b
issuerCommonName: internal1024.internal1024
issuerOrganization: Sourcefire
issuerOrganizationUnit: Development
name: abc
publicKeyFingerprint: 820bad9cae9c1ef9eb2cfea20ebbfe3fe2eb4521
serialNumber: fa:a5:5d:ae:66:34:13:17
subjectCommonName: internal1024.internal1024
subjectOrganization: Sourcefire
subjectOrganizationUnit: Development
type: ExternalCertificate
validityEndDate: '2025-03-07T15:45:51Z'
validityStartDate: '2015-03-10T15:45:51Z'
links:
self: https://172.29.182.90:10228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcertificates?offset=0&limit=2&expanded=true
paging:
count: 3
limit: 2
next:
- https://172.29.182.90:10228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcertificates?offset=2&limit=1&expanded=true
offset: 0
pages: 2
schema:
$ref: '#/components/schemas/ExternalCertificateListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an external certificate. _Check the response section for applicable examples (if any)._**'
operationId: createExternalCertificate
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/externalcertificates ( Test external certificate creation )':
value:
cert: '-----BEGIN CERTIFICATE-----
MIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV
BAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE
ChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy
NDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3
MTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp
dHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs
MTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG
SIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg
x9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6
imwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt
8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC
sDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46
oYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0
dHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx
MDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT
FzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3
hGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko
42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu
rIuPFw==
-----END CERTIFICATE-----'
name: external_cert_3
schema:
$ref: '#/components/schemas/ExternalCertificate'
type: object
description: Input representation of external certificate object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/externalcertificates ( Test external certificate creation )':
value:
cert: '-----BEGIN CERTIFICATE-----
MIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV
BAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE
ChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy
NDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3
MTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp
dHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs
MTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG
SIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg
x9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6
imwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt
8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC
sDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46
oYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0
dHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx
MDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT
FzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3
hGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko
42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu
rIuPFw==
-----END CERTIFICATE-----'
certFingerprint: 50:9D:77:44:D4:A3:AC:3B:E1:F6:11:2E:85:19:15:0B:D0:D4:6B:D3
id: e021425a-0e00-11ed-b900-75c97872e20b
issuerCommonName: internal1024.internal1024
issuerOrganization: Sourcefire
issuerOrganizationUnit: Development
name: external_cert_3
publicKeyFingerprint: 820bad9cae9c1ef9eb2cfea20ebbfe3fe2eb4521
serialNumber: fa:a5:5d:ae:66:34:13:17
subjectCommonName: internal1024.internal1024
subjectOrganization: Sourcefire
subjectOrganizationUnit: Development
type: ExternalCertificate
validityEndDate: '2025-03-07T15:45:51Z'
validityStartDate: '2015-03-10T15:45:51Z'
schema:
$ref: '#/components/schemas/ExternalCertificate'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/filecategories:
get:
deprecated: false
description: '**Get the list of all file categories.**'
operationId: getAllFileCategoryModel
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/filecategories?limit=2&expanded=true ( Success:
Test GET ALL success of all the file categories with expanded=true )'
: value:
items:
- fileTypes:
- id: exampleFileTypeId
name: exampleFileTypeName
type: FileType
- id: exampleFileTypeId2
name: exampleFileTypeName2
type: FileType
id: exampleFileCategoryId
malwareCount: sizeOffileTypes
name: exampleFileCategoryName
type: FileCategory
- fileTypes:
- id: exampleFileTypeId3
name: exampleFileTypeName3
type: FileType
- id: exampleFileTypeId4
name: exampleFileTypeName4
type: FileType
id: exampleFileCategoryId2
malwareCount: sizeOffileTypes
name: exampleFileCategoryName2
type: FileCategory
links:
self: https://example.com:443/api/fmc_config/v1/domain/domainUUID/object/filecategories?limit=2&expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/filecategories?limit=2&expanded=false ( Success:
Test GET ALL success of all the file categories with expanded=false )'
: value:
items:
- id: exampleFileCategoryId
name: exampleFileCategoryName
type: FileCategory
- id: exampleFileCategoryId2
name: exampleFileCategoryName2
type: FileCategory
links:
self: https://example.com:443/api/fmc_config/v1/domain/domainUUID/object/filecategories?limit=2&expanded=false
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/FileCategoryModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/filecategories/{objectId}:
get:
deprecated: false
description: '**Get the file category associated with the specified ID.**'
operationId: getFileCategoryModel
parameters:
- description: Unique identifier of the file category.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/filecategories/filecategory-id ( Success: Test
GET success of a file category )'
: value:
fileTypes:
- id: exampleFileTypeId
name: exampleFileTypeName
type: FileType
- id: exampleFileTypeId2
name: exampleFileTypeName2
type: FileType
id: exampleFileCategoryId
links:
self: https://example.com:443/api/fmc_config/v1/domain/domainUUID/object/filecategories/filecategory-id
malwareCount: sizeOffileTypes
name: exampleFileCategoryName
type: FileCategory
schema:
$ref: '#/components/schemas/FileCategoryModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/filetypes:
get:
deprecated: false
description: '**Get the list of all file types.**'
operationId: getAllFileTypeModel
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/filetypes?limit=2&expanded=true ( Success: Test
GET ALL success of all the file types with expanded=true )'
: value:
items:
- description: exampleFileTypeDescription
id: exampleFileTypeId
links:
self: https://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/filetypes/exampleFileTypeId
name: exampleFileTypeName
type: FileType
- description: exampleFileTypeDescription2
id: exampleFileTypeId2
links:
self: https://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/filetypes/exampleFileTypeId2
name: ExampleFileTypeName2
type: FileType
links:
self: https://example.com:443/api/fmc_config/v1/domain/domainUUID/object/filetypes?limit=2&expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/filetypes?limit=2&expanded=false ( Success: Test
GET ALL success of all the file types with expanded=false )'
: value:
items:
- id: exampleFileTypeId
links:
self: https://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/filetypes/exampleFileTypeId
name: exampleFileTypeName
type: FileType
- id: exampleFileTypeId2
links:
self: https://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/filetypes/exampleFileTypeId2
name: ExampleFileTypeName2
type: FileType
links:
self: https://example.com:443/api/fmc_config/v1/domain/domainUUID/object/filetypes?limit=2&expanded=false
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/FileTypeModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/filetypes/{objectId}:
get:
deprecated: false
description: '**Get the file type associated with the specified ID.**'
operationId: getFileTypeModel
parameters:
- description: Unique identifier of the file type.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/filetypes/fileType-id ( Success: Test GET success of a file type )':
value:
description: exampleFileTypeDescription
id: exampleFileTypeId
links:
self: https://example.com:443/api/fmc_config/v1/domain/domainUUID/object/filetypes/fileType-id
name: exampleFileTypeName
type: FileType
schema:
$ref: '#/components/schemas/FileTypeModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/fqdns:
delete:
deprecated: false
description: '**Delete all fully-qualified domain names. Use filtering to limit the deleted names. _Check the response
section for applicable examples (if any)._**'
operationId: deleteMultipleFQDNObject
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
"ids:id1,id2,...".ids is a comma-separated list
of rule IDs to be deleted.
in: query
name: filter
required: false
schema:
type: string
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: true
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns/5555-6666-7777-8888 ( DELETE a
FQDN object for the given UUID )'
: value:
description: Test Description
dnsResolution: IPV6_ONLY
id: 5555-6666-7777-8888
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/fqdns/5555-6666-7777-8888
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
name: TestFQDN
overridable: false
type: FQDN
value: www.cisco.com
? 'Example 2 : DELETE /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns/5555-6666-7777-8888?overrideTargetId=3333-4444-5555-666
( DELETE a FQDN object override for the given UUID )'
: value:
description: Test Description
dnsResolution: IPV6_ONLY
id: 5555-6666-7777-8888
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/fqdns/5555-6666-7777-8888?overrideTargetId=3333-4444-5555-666
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
name: TestFQDN
overridable: false
overrides:
parent:
id: 5555-6666-7777-8888
type: FQDN
target:
id: 3333-4444-5555-666
name: Global \ Asia
type: Domain
type: FQDN
value: www.cisco.com
? 'Example 3 : DELETE /fmc_config/v1/domain/domainUuid/object/fqdns/fqdn2_uuid?overrideTargetId=device_uuid
( DELETE an override on an FQDN object )'
: value:
description: ' '
dnsResolution: IPV4_AND_IPV6
id: fqdn2_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/fqdns/fqdn2_uuid?overrideTargetId=device_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
timestamp: 1527230774136.0
name: fqdn2
overridable: true
overrides:
parent:
id: fqdn2_uuid
type: FQDN
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: FQDN
value: cisco.com
schema:
$ref: '#/components/schemas/FQDNObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the list of all fully-qualified domain names.**'
operationId: getAllFQDNObject
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
"ids:id1,id2,...".ids is a comma-separated list
of rule IDs.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns ( Get all paginated FQDN objects )':
value:
items:
- id: 1111-2222-3333-4444
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/fqdns/1111-2222-3333-4444
name: newFQDN
type: FQDN
- id: 2222-3333-4444-5555
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/fqdns/2222-3333-4444-5555
name: Test1
type: FQDN
links:
self: /fmc_config/v1/domain/default/object/fqdns?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns?expanded=true ( Get all paginated
FQDN objects with expanded set to true )'
: value:
items:
- description: ' '
dnsResolution: IPV4_ONLY
id: 1111-2222-3333-4444
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/fqdns/1111-2222-3333-4444
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
name: MarketPlace
overridable: false
type: FQDN
value: marketplace.cisco.com
- description: ' '
dnsResolution: IPV4_AND_IPV6
id: 2222-3333-4444-5555
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/fqdns/2222-3333-4444-5555
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
name: Test1
overridable: false
type: FQDN
value: downloads.cisco.com
links:
self: /fmc_config/v1/domain/default/object/fqdns?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 3 : GET /fmc_config/v1/domain/domainUuid/object/fqdns?expanded=true&overrideTargetId=4444-5555-6666-7777
( Success: Test GET ALL method from global domain for fqdnObject when overrides are assigned to child domain
)'
: value:
items:
- description: ' '
id: 2222-3333-4444-5555
links:
parent: /fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /fmc_config/v1/domain/domainUuid/object/fqdns/2222-3333-4444-5555?overrideTargetId=3333-4444-5555-666
metadata:
domain:
id: 3333-4444-5555-666
name: Global \ Asia
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
name: pvs_global
overridable: true
overrides:
parent:
id: 2222-3333-4444-5555
type: FQDN
target:
id: 3333-4444-5555-666
name: Global \ Asia
type: Domain
type: FQDN
value: marketplace.cisco.com
links:
self: /fmc_config/v1/domain/domainUuid/object/fqdns?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 4 : GET /fmc_config/v1/domain/4444-5555-6666-7777/object/fqdns?expanded=true&overrideTargetId=4444-5555-6666-7777
( Success: Test GET ALL method from child domain for fqdnObject when overrides are assigned to child domain
)'
: value:
items:
- description: ' '
id: 2222-3333-4444-5555
links:
parent: /fmc_config/v1/domain/3333-4444-5555-666/object/networkaddresses
self: /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns/2222-3333-4444-5555?overrideTargetId=3333-4444-5555-666
metadata:
domain:
id: 3333-4444-5555-666
name: Global \ Asia
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
name: pvs_global
overridable: true
overrides:
parent:
id: 2222-3333-4444-5555
type: FQDN
target:
id: 3333-4444-5555-666
name: Global \ Asia
type: Domain
type: FQDN
value: marketplace.cisco.com
links:
self: /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns?offset=0&limit=1&overrideTargetId=3333-4444-5555-666
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/FQDNObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a fully-qualified domain name. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleFQDNObject
parameters:
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns ( POST to create a FQDN object )':
value:
description: Test Description
dnsResolution: IPV4_ONLY
name: TestFQDN
type: FQDN
value: downloads.cisco.com
'Example 2 : POST /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns ( POST to create a FQDN object Override )':
value:
description: Test Description
dnsResolution: IPV4_ONLY
name: TestFQDN
overrides:
parent:
id: 5555-6666-7777-8888
target:
id: 3333-4444-5555-666
type: Domain
type: FQDN
value: downloads.cisco.com
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/fqdns?bulk=true ( Bulk POST operation on fqdn objects
with overrides )'
: value:
- description: ' '
id: fqdn_obj_uuid
name: fqdn_obj
overridable: true
overrides:
parent:
id: fqdn_obj_uuid
type: FQDN
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: FQDN
value: www.cisco.com
- description: ' '
id: fqdn_obj_uuid
name: fqdn_obj
overridable: true
overrides:
parent:
id: fqdn_obj_uuid
type: FQDN
target:
id: device_uuid
name: FTDv_R1
type: Device
type: FQDN
value: www.google.com
'Example 4 : POST /fmc_config/v1/domain/domainUuid/object/fqdns ( POST to create overrides on an FQDN object )':
value:
description: ' '
dnsResolution: IPV4_AND_IPV6
id: fqdn1_uuid
name: fqdn2
overridable: true
overrides:
parent:
id: fqdn1_uuid
type: FQDN
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: FQDN
value: example.com
schema:
$ref: '#/components/schemas/FQDNObject'
type: object
description: Input representation of fully-qualified domain name object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns ( POST to create a FQDN object )':
value:
dnsResolution: IPV4_ONLY
id: 5555-6666-7777-8888
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/fqdns/5555-6666-7777-8888
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
name: TestFQDN
overridable: false
type: FQDN
value: downloads.cisco.com
'Example 2 : POST /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns ( POST to create a FQDN object Override )':
value:
dnsResolution: IPV4_ONLY
id: 5555-6666-7777-8888
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/fqdns/5555-6666-7777-8888?overrideTargetId=3333-4444-5555-666
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
name: TestFQDN
overridable: false
overrides:
parent:
id: 5555-6666-7777-8888
type: FQDN
target:
id: 3333-4444-5555-666
name: Global \ Asia
type: Domain
type: FQDN
value: downloads.cisco.com
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/fqdns?bulk=true ( Bulk POST operation on fqdn
objects with overrides )'
: value:
items:
- dnsResolution: IPV4_AND_IPV6
id: fqdn_obj_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/fqdns/fqdn_obj_uuid
metadata:
domain:
id: domain_uuid
name: Global \ EUROPE
lastUser:
name: pvs
parentType: NetworkAddress
timestamp: 0
name: fqdn_obj
overridable: true
overrides:
parent:
id: fqdn_obj_uuid
type: FQDN
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: FQDN
value: www.cisco.com
- dnsResolution: IPV4_AND_IPV6
id: fqdn_obj_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/fqdns/fqdn_obj_uuid
metadata:
domain:
id: domain_uuid
name: Global \ ASIA
lastUser:
name: pvs
parentType: NetworkAddress
timestamp: 0
name: fqdn_obj
overridable: true
overrides:
parent:
id: fqdn_obj_uuid
type: FQDN
target:
id: device_uuid
name: FTDv_R1
type: Device
type: FQDN
value: www.google.com
links:
self: /api/fmc_config/v1/domain/domainUuid/object/fqdns?bulk=true
'Example 4 : POST /fmc_config/v1/domain/domainUuid/object/fqdns ( POST to create overrides on an FQDN object )':
value:
dnsResolution: IPV4_AND_IPV6
id: fqdn1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/fqdns/fqdn1_uuid?overrideTargetId=device_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
timestamp: 0
name: fqdn2
overridable: true
overrides:
parent:
id: fqdn1_uuid
type: FQDN
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: FQDN
value: example.com
schema:
$ref: '#/components/schemas/FQDNObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/fqdns/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all overrides on a fully-qualified domain name. Response will always be in expanded form. If passed,
the "expanded" query parameter will be ignored.**'
operationId: getAllFQDNOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/fqdns/fqdnObjectUUID/overrides ( Get all overrides
on given FQDN objects )'
: value:
items:
- description: ' '
dnsResolution: IPV4_AND_IPV6
id: fqdnObjectUUID
links:
self: /fmc_config/v1/domain/domainUUID/object/fqdns/fqdnObjectUUID?overrideTargetId=targetUUID
metadata:
domain:
id: domainUUID
name: Global \ INDIA \ BENGALURU
lastUser:
name: user1
timestamp: 1520428174236.0
name: fqdn_obj
overridable: true
overrides:
parent:
id: fqdnObjectUUID
type: FQDN
target:
id: targetUUID
name: 10.10.19.27
type: Device
type: FQDN
value: a.b.c.d.com
links:
self: /fmc_config/v1/domain/domainUUID/object/fqdns/fqdnObjectUUID/overrides?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/FQDNOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/fqdns/{containerUUID}/overrides/{objectId}:
get:
deprecated: false
description: '**Get the specified override on a fully-qualified domain name. Response will always be in expanded form.
If passed, the "expanded" query parameter will be ignored.**'
operationId: getFQDNOverride
parameters:
- description: Unique identifier of the fully-qualified domain override id.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FQDNOverride'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/fqdns/{objectId}:
delete:
deprecated: false
description: '**Delete the fully-qualified domain name associated with the specified ID. _Check the response section
for applicable examples (if any)._**'
operationId: deleteFQDNObject
parameters:
- description: Unique identifier of the fully-qualified domain name.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns/5555-6666-7777-8888 ( DELETE a
FQDN object for the given UUID )'
: value:
description: Test Description
dnsResolution: IPV6_ONLY
id: 5555-6666-7777-8888
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/fqdns/5555-6666-7777-8888
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
name: TestFQDN
overridable: false
type: FQDN
value: www.cisco.com
? 'Example 2 : DELETE /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns/5555-6666-7777-8888?overrideTargetId=3333-4444-5555-666
( DELETE a FQDN object override for the given UUID )'
: value:
description: Test Description
dnsResolution: IPV6_ONLY
id: 5555-6666-7777-8888
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/fqdns/5555-6666-7777-8888?overrideTargetId=3333-4444-5555-666
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
name: TestFQDN
overridable: false
overrides:
parent:
id: 5555-6666-7777-8888
type: FQDN
target:
id: 3333-4444-5555-666
name: Global \ Asia
type: Domain
type: FQDN
value: www.cisco.com
? 'Example 3 : DELETE /fmc_config/v1/domain/domainUuid/object/fqdns/fqdn2_uuid?overrideTargetId=device_uuid
( DELETE an override on an FQDN object )'
: value:
description: ' '
dnsResolution: IPV4_AND_IPV6
id: fqdn2_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/fqdns/fqdn2_uuid?overrideTargetId=device_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
timestamp: 1527230774136.0
name: fqdn2
overridable: true
overrides:
parent:
id: fqdn2_uuid
type: FQDN
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: FQDN
value: cisco.com
schema:
$ref: '#/components/schemas/FQDNObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the fully-qualified domain name associated with the specified ID.**'
operationId: getFQDNObject
parameters:
- description: Unique identifier of the fully-qualified domain name.
in: path
name: objectId
required: true
schema:
type: string
- description: Get the overrides associated with the specified fully-qualified domain name.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns/5555-6666-7777-8888 ( GET a FQDN
object for the given UUID )'
: value:
description: Test Description
dnsResolution: IPV4_ONLY
id: 5555-6666-7777-8888
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/fqdns/5555-6666-7777-8888
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
name: TestFQDN
overridable: false
type: FQDN
value: www.cisco.com
? 'Example 2 : GET /fmc_config/v1/domain/domainUuid/object/fqdns/2222-3333-4444-5555?expanded=true&overrideTargetId=3333-4444-5555-666
( Success: Test GET method from global domain on a specific fqdnObject which has override assigned as child
domain )'
: value:
description: ' '
id: 2222-3333-4444-5555
links:
parent: /fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /fmc_config/v1/domain/domainUuid/object/fqdns/2222-3333-4444-5555?overrideTargetId=3333-4444-5555-666
metadata:
domain:
id: 3333-4444-5555-666
name: Global \ Asia
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
name: pvs_global
overridable: true
overrides:
parent:
id: 2222-3333-4444-5555
type: FQDN
target:
id: 3333-4444-5555-666
name: Global \ Asia
type: Domain
type: FQDN
value: marketplace.cisco.com
? 'Example 3 : GET /fmc_config/v1/domain/4444-5555-6666-7777/object/fqdns/2222-3333-4444-5555?expanded=true&overrideTargetId=3333-4444-5555-666
( Success: Test GET method from child domain on a fqdnObject which has child domain assigned as override
)'
: value:
description: ' '
id: 2222-3333-4444-5555
links:
parent: /fmc_config/v1/domain/3333-4444-5555-666/object/networkaddresses
self: /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns/2222-3333-4444-5555?overrideTargetId=3333-4444-5555-666
metadata:
domain:
id: 3333-4444-5555-666
name: Global \ Asia
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
name: pvs_global
overridable: true
overrides:
parent:
id: 2222-3333-4444-5555
type: FQDN
target:
id: 3333-4444-5555-666
name: Global \ Asia
type: Domain
type: FQDN
value: marketplace.cisco.com
? 'Example 4 : GET /fmc_config/v1/domain/4444-5555-6666-7777/object/fqdns/1111-2222-3333-4444?expanded=true&overrideTargetId=dcea-1111-3333-2222
( Success: Test GET method from child domain on a fqdnObject which has device assigned as override )'
: value:
description: ' '
id: 1111-2222-3333-4444
links:
parent: /fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /fmc_config/v1/domain/domainUuid/object/fqdns/1111-2222-3333-4444?overrideTargetId=dcea-1111-3333-2222
metadata:
domain:
id: 3333-4444-5555-666
name: Global \ Asia
ipType: V_4
lastUser:
name: api
parentType: NetworkAddress
name: pvs_global
overridable: true
overrides:
parent:
id: 1111-2222-3333-4444
type: FQDN
target:
id: dcea-1111-3333-2222
name: 192.168.0.166
type: Device
type: FQDN
value: marketplace.cisco.com
schema:
$ref: '#/components/schemas/FQDNObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the fully-qualified domain name associated with the specified ID. _Check the response section
for applicable examples (if any)._**'
operationId: updateFQDNObject
parameters:
- description: Unique identifier of the fully-qualified domain name.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : PUT /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns/5555-6666-7777-8888 ( PUT to update a FQDN object )':
value:
description: Test Description
dnsResolution: IPV6_ONLY
id: 5555-6666-7777-8888
name: TestFQDN
overridable: false
type: FQDN
value: www.cisco.com
? 'Example 2 : PUT /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns/5555-6666-7777-8888 ( PUT to update
a FQDN object Override )'
: value:
description: Test Description
dnsResolution: IPV6_ONLY
id: 5555-6666-7777-8888
name: TestFQDN
overridable: false
overrides:
parent:
id: 5555-6666-7777-8888
target:
id: 3333-4444-5555-666
type: Domain
type: FQDN
value: www.cisco.com
'Example 3 : PUT /fmc_config/v1/domain/domainUuid/object/fqdns/fqdn2_uuid ( PUT to update override on a host object. )':
value:
description: ' '
dnsResolution: IPV4_AND_IPV6
id: fqdn2_uuid
name: fqdn2
overridable: true
overrides:
parent:
id: fqdn2_uuid
type: FQDN
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: FQDN
value: cisco.com
schema:
$ref: '#/components/schemas/FQDNObject'
type: object
description: Input representation of fully-qualified domain name object.
required: true
responses:
'200':
content:
application/json:
examples:
'Example 1 : PUT /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns/5555-6666-7777-8888 ( PUT to update a FQDN object )':
value:
dnsResolution: IPV6_ONLY
id: 5555-6666-7777-8888
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/fqdns/5555-6666-7777-8888
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
name: TestFQDN
overridable: false
type: FQDN
value: www.cisco.com
? 'Example 2 : PUT /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns/5555-6666-7777-8888 ( PUT to update
a FQDN object Override )'
: value:
dnsResolution: IPV6_ONLY
id: 5555-6666-7777-8888
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/fqdns/5555-6666-7777-8888?overrideTargetId=3333-4444-5555-666
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
name: TestFQDN
overridable: false
overrides:
parent:
id: 5555-6666-7777-8888
type: FQDN
target:
id: 3333-4444-5555-666
name: Global \ Asia
type: Domain
type: FQDN
value: www.cisco.com
'Example 3 : PUT /fmc_config/v1/domain/domainUuid/object/fqdns/fqdn2_uuid ( PUT to update override on a host object. )':
value:
dnsResolution: IPV4_AND_IPV6
id: fqdn2_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/fqdns/fqdn2_uuid?overrideTargetId=device_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: NetworkAddress
timestamp: 0
name: fqdn2
overridable: true
overrides:
parent:
id: fqdn2_uuid
type: FQDN
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: FQDN
value: cisco.com
schema:
$ref: '#/components/schemas/FQDNObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/geolocations:
get:
deprecated: false
description: '**Get the list of all geolocation objects.**'
operationId: getAllGeoLocationObject
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/geolocations ( Get all paginated geolocation objects )':
value:
items:
- id: geolocationUUID
links:
self: fmc_config/v1/domain/DomainUUID/object/geolocations/geolocationUUID
name: geolocation_1
type: Geolocation
links:
self: /fmc_config/v1/domain/DomainUUID/object/geolocations?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/geolocations?expanded=true ( Get all paginated
geolocation objects )'
: value:
items:
- continents:
- countries:
- id: '10'
iso2: aq
iso3: ata
name: Antarctica
type: Country
- id: '260'
iso2: tf
iso3: atf
name: French Southern Territories
type: Country
- id: '74'
iso2: bv
iso3: bvt
name: Bouvet Island
type: Country
id: '2'
name: Antarctica
type: Continent
countries:
- id: '356'
iso2: in
iso3: ind
name: India
type: Country
id: geolocationUUID
links:
self: fmc_config/v1/domain/DomainUUID/object/geolocations/geolocationUUID
name: geolocation_1
type: Geolocation
links:
self: /fmc_config/v1/domain/DomainUUID/object/geolocations?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/GeoLocationObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a geolocation object. _Check the response section for applicable examples (if any)._**'
operationId: createGeoLocationObject
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GeoLocationObject'
type: object
description: Input representation of geolocation objects.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/GeoLocationObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/geolocations/{objectId}:
delete:
deprecated: false
description: '**Delete the geolocation associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteGeoLocationObject
parameters:
- description: Unique identifier of the geolocation.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GeoLocationObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the geolocation object associated with the specified ID.**'
operationId: getGeoLocationObject
parameters:
- description: Unique identifier of the geolocation.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GeoLocationObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the geolocation associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateGeoLocationObject
parameters:
- description: Unique identifier of the geolocation.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GeoLocationObject'
type: object
description: Input representation of geolocation objects.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GeoLocationObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/globaltimezones:
get:
deprecated: false
description: '**Get all the global time zones in the IANA tz database.**'
operationId: getAllGlobalTimeZone
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GlobalTimeZoneListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/globaltimezones/{objectId}:
get:
deprecated: false
description: '**Get the IANA global time zone associated with the specified ID.**'
operationId: getGlobalTimeZone
parameters:
- description: Unique identifier of the global time zone as per the IANA tz database.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GlobalTimeZone'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/grouppolicies:
get:
deprecated: false
description: '**Get the list of VPN group policies.**'
operationId: getAllGroupPolicyModel
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/grouppolicies ( Get ALL Group policy object by ID )':
value:
advancedSettings:
restrictVPNToVLANId: 5
sessionSettings:
accessHours:
id: accessHoursUUID
name: timerangehours
type: TimeRange
maxConnectionTimeAlertInterval: 1
maxConnectionTimeout: null
simultaneousLoginPerUser: 3
vpnIdleTimeout: 30
vpnIdleTimeoutAlertInterval: 1
vpnTrafficFilterACL:
id: vpnTrafficFilterACLUUID
name: vpnTrafficfilter
type: ExtendedAccessList
anyConnectSettings:
clientModules:
- enableModuleDownload: false
moduleProfile:
id: vpnClientProfileUUID
name: ampenabler
type: AnyconnectFile
moduleType: AMP_ENABLER
connectionSettings:
bypassUnsupportProtocol: false
clientDPDInterval: 30
clientFirewallPrivateNetworkRules:
id: clientFirewallPrivateNetworkRulesUUID
name: privateNetACL
type: ExtendedAccessList
clientFirewallPublicNetworkRules:
id: clientFirewallPublicNetworkRulesUUID
name: publicNetACL
type: ExtendedAccessList
enableClientDPD: true
enableGatewayDPD: true
enableKeepAliveMessages: true
enableSSLRekey: false
gatewayDPDInterval: 30
keepAliveMessageInterval: 20
rekeyInterval: 4
rekeyMethod: NEW_TUNNEL
customAttributes:
- anyConnectAttribute: PER_APP_VPN
customAttributeObject:
id: customAttributeObjectUUID
name: customAttributeObjectName
type: AnyConnectCustomAttribute
sslSettings:
dtlsCompression: DISABLED
ignoreDFBit: false
mtuSize: 1000
sslCompression: DISABLED
vpnClientProfile:
id: 2d9d6bda-865a-11e8-8472-bb2ae5b3416b
name: remoteaccessprofile
type: AnyconnectFile
description: This is sample group policy
generalSettings:
addressAssignment:
defaultDomainName: cisco.com
dhcpScope:
id: dhcpScopeUUID
name: dhcpscope
type: Network
ipv4LocalAddressPool:
- id: ipv4LocalAddressPoolUUID
name: ipv4pool1
type: Ipv4AddressPool
banner: This is a sample Banner
primaryDNSServer:
id: primaryDNSServerUUID
name: primarydns
type: Network
primaryWINSServer:
id: primaryWINSServerUUID
name: primarywins
type: Network
secondaryDNSServer:
id: secondaryDNSServerUUID
name: secondarydns
type: Network
secondaryWINSServer:
id: secondaryWINSServerUUID
name: secondarywins
type: Network
splitTunnelSettings:
ipv4SplitTunnelPolicy: TUNNEL_ALL
ipv6SplitTunnelPolicy: TUNNEL_ALL
splitDNSDomainList: SplitACL
splitDNSRequestPolicy: USE_SPLIT_TUNNEL_SETTING
splitTunnelACL:
id: splitTunnelACLUUID
name: splitacl
type: StandardAccessList|ExtendedAccessList
id: f3b4fda4-1e03-11e8-b53e-e7bb7add7360
links:
self: https://fmcip/api/fmc_config/v1/domain/DomainUUID/object/grouppolicies/grouppolicyUUID
metadata: {}
name: grouppolicy1
protocol: SSL
type: GroupPolicy
schema:
$ref: '#/components/schemas/GroupPolicyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a VPN group policy. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleGroupPolicyModel
parameters:
- description: Enables bulk create for Group Policy object.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/grouppolicies ( POST operation for group policy object )':
value:
advancedSettings:
sessionSettings:
maxConnectionTimeAlertInterval: 1
maxConnectionTimeout: -1
simultaneousLoginPerUser: 3
vpnIdleTimeout: 30
vpnIdleTimeoutAlertInterval: 1
anyConnectSettings:
connectionSettings:
bypassUnsupportProtocol: false
clientDPDInterval: 30
enableClientDPD: true
enableGatewayDPD: true
enableKeepAliveMessages: true
enableSSLRekey: false
gatewayDPDInterval: 30
keepAliveMessageInterval: 20
rekeyInterval: 4
rekeyMethod: NEW_TUNNEL
customAttributes:
- anyConnectAttribute: PER_APP_VPN
customAttributeObject:
id: 00505681-162B-0ed3-0000-966367641621
name: custom_attr_2
type: AnyConnectCustomAttribute
sslSettings:
dtlsCompression: DISABLED
ignoreDFBit: false
mtuSize: 1406
sslCompression: DISABLED
description: description
enableIPsecIKEv2Protocol: true
enableSSLProtocol: true
generalSettings:
addressAssignment:
dhcpScope:
id: 00505681-162B-0ed3-0000-536870912003
name: obj
type: Network
ipv4LocalAddressPool:
- id: 00505681-162B-0ed3-0000-476741369859
name: ipv4_pool_1
type: IPv4AddressPool
banner: banner
primaryDNSServer:
id: 00505681-162B-0ed3-0000-536870912021
name: host_1
type: Host
primaryWINSServer:
id: 00505681-162B-0ed3-0000-536870912057
name: host_3
type: Host
secondaryDNSServer:
id: 00505681-162B-0ed3-0000-536870912039
name: host_2
type: Host
secondaryWINSServer:
id: 00505681-162B-0ed3-0000-536870912075
name: host_4
type: Host
splitTunnelSettings:
ipv4SplitTunnelPolicy: TUNNEL_ALL
ipv6SplitTunnelPolicy: TUNNEL_ALL
splitDNSRequestPolicy: USE_SPLIT_TUNNEL_SETTING
name: rest_1
type: GroupPolicy
schema:
$ref: '#/components/schemas/GroupPolicyModel'
type: object
description: Input representation of Group Policy object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/grouppolicies ( POST operation for group policy object )':
value:
advancedSettings:
restrictVPNToVLANId: 5
sessionSettings:
accessHours:
id: accessHoursUUID
name: timerangehours
type: TimeRange
maxConnectionTimeAlertInterval: 1
maxConnectionTimeout: null
simultaneousLoginPerUser: 3
vpnIdleTimeout: 30
vpnIdleTimeoutAlertInterval: 1
vpnTrafficFilterACL:
id: vpnTrafficFilterACLUUID
name: vpnTrafficfilter
type: ExtendedAccessList
anyConnectSettings:
clientModules:
- enableModuleDownload: false
moduleProfile:
id: vpnClientProfileUUID
name: ampenabler
type: AnyconnectFile
moduleType: AMP_ENABLER
connectionSettings:
bypassUnsupportProtocol: false
clientDPDInterval: 30
clientFirewallPrivateNetworkRules:
id: clientFirewallPrivateNetworkRulesUUID
name: privateNetACL
type: ExtendedAccessList
clientFirewallPublicNetworkRules:
id: clientFirewallPublicNetworkRulesUUID
name: publicNetACL
type: ExtendedAccessList
enableClientDPD: true
enableGatewayDPD: true
enableKeepAliveMessages: true
enableSSLRekey: false
gatewayDPDInterval: 30
keepAliveMessageInterval: 20
rekeyInterval: 4
rekeyMethod: NEW_TUNNEL
customAttributes:
- anyConnectAttribute: PER_APP_VPN
customAttributeObject:
id: customAttributeObjectUUID
name: customAttributeObjectName
type: AnyConnectCustomAttribute
sslSettings:
dtlsCompression: DISABLED
ignoreDFBit: false
mtuSize: 1000
sslCompression: DISABLED
vpnClientProfile:
id: 2d9d6bda-865a-11e8-8472-bb2ae5b3416b
name: remoteaccessprofile
type: AnyconnectFile
description: This is sample group policy
generalSettings:
addressAssignment:
defaultDomainName: cisco.com
dhcpScope:
id: dhcpScopeUUID
name: dhcpscope
type: Network
ipv4LocalAddressPool:
- id: ipv4LocalAddressPoolUUID
name: ipv4pool1
type: Ipv4AddressPool
banner: This is a sample Banner
primaryDNSServer:
id: primaryDNSServerUUID
name: primarydns
type: Network
primaryWINSServer:
id: primaryWINSServerUUID
name: primarywins
type: Network
secondaryDNSServer:
id: secondaryDNSServerUUID
name: secondarydns
type: Network
secondaryWINSServer:
id: secondaryWINSServerUUID
name: secondarywins
type: Network
splitTunnelSettings:
ipv4SplitTunnelPolicy: TUNNEL_ALL
ipv6SplitTunnelPolicy: TUNNEL_ALL
splitDNSDomainList: SplitACL
splitDNSRequestPolicy: USE_SPLIT_TUNNEL_SETTING
splitTunnelACL:
id: splitTunnelACLUUID
name: splitacl
type: StandardAccessList|ExtendedAccessList
id: f3b4fda4-1e03-11e8-b53e-e7bb7add7360
links:
self: https://fmcip/api/fmc_config/v1/domain/DomainUUID/object/grouppolicies/grouppolicyUUID
metadata: {}
name: grouppolicy1
protocol: SSL
type: GroupPolicy
schema:
$ref: '#/components/schemas/GroupPolicyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/grouppolicies/{objectId}:
delete:
deprecated: false
description: '**Delete the VPN group policy associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteGroupPolicyModel
parameters:
- description: Unique identifier of the VPN group policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/grouppolicies/grouppolicyUUID ( Delete operation
for group policy object )'
: value:
advancedSettings:
restrictVPNToVLANId: 5
sessionSettings:
accessHours:
id: accessHoursUUID
name: timerangehours
type: TimeRange
maxConnectionTimeAlertInterval: 1
maxConnectionTimeout: null
simultaneousLoginPerUser: 3
vpnIdleTimeout: 30
vpnIdleTimeoutAlertInterval: 1
vpnTrafficFilterACL:
id: vpnTrafficFilterACLUUID
name: vpnTrafficfilter
type: ExtendedAccessList
anyConnectSettings:
clientModules:
- enableModuleDownload: false
moduleProfile:
id: vpnClientProfileUUID
name: ampenabler
type: AnyconnectFile
moduleType: AMP_ENABLER
connectionSettings:
bypassUnsupportProtocol: false
clientDPDInterval: 30
clientFirewallPrivateNetworkRules:
id: clientFirewallPrivateNetworkRulesUUID
name: privateNetACL
type: ExtendedAccessList
clientFirewallPublicNetworkRules:
id: clientFirewallPublicNetworkRulesUUID
name: publicNetACL
type: ExtendedAccessList
enableClientDPD: true
enableGatewayDPD: true
enableKeepAliveMessages: true
enableSSLRekey: false
gatewayDPDInterval: 30
keepAliveMessageInterval: 20
rekeyInterval: 4
rekeyMethod: NEW_TUNNEL
customAttributes:
- anyConnectAttribute: PER_APP_VPN
customAttributeObject:
id: customAttributeObjectUUID
name: customAttributeObjectName
type: AnyConnectCustomAttribute
sslSettings:
dtlsCompression: DISABLED
ignoreDFBit: false
mtuSize: 1000
sslCompression: DISABLED
vpnClientProfile:
id: 2d9d6bda-865a-11e8-8472-bb2ae5b3416b
name: remoteaccessprofile
type: AnyconnectFile
description: PUT operation for Group Policy
generalSettings:
addressAssignment:
defaultDomainName: cisco.com
dhcpScope:
id: dhcpScopeUUID
name: dhcpscope
type: Network
ipv4LocalAddressPool:
- id: ipv4LocalAddressPoolUUID
name: ipv4pool1
type: Ipv4AddressPool
banner: This is a sample Banner
primaryDNSServer:
id: primaryDNSServerUUID
name: primarydns
type: Network
primaryWINSServer:
id: primaryWINSServerUUID
name: primarywins
type: Network
secondaryDNSServer:
id: secondaryDNSServerUUID
name: secondarydns
type: Network
secondaryWINSServer:
id: secondaryWINSServerUUID
name: secondarywins
type: Network
splitTunnelSettings:
ipv4SplitTunnelPolicy: TUNNEL_ALL
ipv6SplitTunnelPolicy: TUNNEL_ALL
splitDNSDomainList: SplitACL
splitDNSRequestPolicy: USE_SPLIT_TUNNEL_SETTING
splitTunnelACL:
id: splitTunnelACLUUID
name: splitacl
type: StandardAccessList|ExtendedAccessList
id: f3b4fda4-1e03-11e8-b53e-e7bb7add7360
links:
self: https://fmcip/api/fmc_config/v1/domain/DomainUUID/object/grouppolicies/grouppolicyUUID
metadata: {}
name: PUTGroupPolicy
protocol: SSL
type: GroupPolicy
schema:
$ref: '#/components/schemas/GroupPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the VPN group policy associated with the specified ID.**'
operationId: getGroupPolicyModel
parameters:
- description: Unique identifier of the VPN group policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/grouppolicies/grouppolicyUUID ( Get Group policy object by ID )':
value:
advancedSettings:
restrictVPNToVLANId: 5
sessionSettings:
accessHours:
id: accessHoursUUID
name: timerangehours
type: TimeRange
maxConnectionTimeAlertInterval: 1
maxConnectionTimeout: null
simultaneousLoginPerUser: 3
vpnIdleTimeout: 30
vpnIdleTimeoutAlertInterval: 1
vpnTrafficFilterACL:
id: vpnTrafficFilterACLUUID
name: vpnTrafficfilter
type: ExtendedAccessList
anyConnectSettings:
clientModules:
- enableModuleDownload: false
moduleProfile:
id: vpnClientProfileUUID
name: ampenabler
type: AnyconnectFile
moduleType: AMP_ENABLER
connectionSettings:
bypassUnsupportProtocol: false
clientDPDInterval: 30
clientFirewallPrivateNetworkRules:
id: clientFirewallPrivateNetworkRulesUUID
name: privateNetACL
type: ExtendedAccessList
clientFirewallPublicNetworkRules:
id: clientFirewallPublicNetworkRulesUUID
name: publicNetACL
type: ExtendedAccessList
enableClientDPD: true
enableGatewayDPD: true
enableKeepAliveMessages: true
enableSSLRekey: false
gatewayDPDInterval: 30
keepAliveMessageInterval: 20
rekeyInterval: 4
rekeyMethod: NEW_TUNNEL
customAttributes:
- anyConnectAttribute: PER_APP_VPN
customAttributeObject:
id: customAttributeObjectUUID
name: customAttributeObjectName
type: AnyConnectCustomAttribute
sslSettings:
dtlsCompression: DISABLED
ignoreDFBit: false
mtuSize: 1000
sslCompression: DISABLED
vpnClientProfile:
id: 2d9d6bda-865a-11e8-8472-bb2ae5b3416b
name: remoteaccessprofile
type: AnyconnectFile
description: This is sample group policy
generalSettings:
addressAssignment:
defaultDomainName: cisco.com
dhcpScope:
id: dhcpScopeUUID
name: dhcpscope
type: Network
ipv4LocalAddressPool:
- id: ipv4LocalAddressPoolUUID
name: ipv4pool1
type: Ipv4AddressPool
banner: This is a sample Banner
primaryDNSServer:
id: primaryDNSServerUUID
name: primarydns
type: Network
primaryWINSServer:
id: primaryWINSServerUUID
name: primarywins
type: Network
secondaryDNSServer:
id: secondaryDNSServerUUID
name: secondarydns
type: Network
secondaryWINSServer:
id: secondaryWINSServerUUID
name: secondarywins
type: Network
splitTunnelSettings:
ipv4SplitTunnelPolicy: TUNNEL_ALL
ipv6SplitTunnelPolicy: TUNNEL_ALL
splitDNSDomainList: SplitACL
splitDNSRequestPolicy: USE_SPLIT_TUNNEL_SETTING
splitTunnelACL:
id: splitTunnelACLUUID
name: splitacl
type: StandardAccessList|ExtendedAccessList
id: f3b4fda4-1e03-11e8-b53e-e7bb7add7360
links:
self: https://fmcip/api/fmc_config/v1/domain/DomainUUID/object/grouppolicies/grouppolicyUUID
metadata: {}
name: grouppolicy1
protocol: SSL
type: GroupPolicy
schema:
$ref: '#/components/schemas/GroupPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the VPN group policy associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateGroupPolicyModel
parameters:
- description: Unique identifier of the VPN group policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/grouppolicies/grouppolicyUUID ( PUT operation for
group policy object )'
: value:
advancedSettings:
sessionSettings:
maxConnectionTimeAlertInterval: 1
maxConnectionTimeout: -1
simultaneousLoginPerUser: 3
vpnIdleTimeout: 30
vpnIdleTimeoutAlertInterval: 1
anyConnectSettings:
connectionSettings:
bypassUnsupportProtocol: false
clientDPDInterval: 30
enableClientDPD: true
enableGatewayDPD: true
enableKeepAliveMessages: true
enableSSLRekey: false
gatewayDPDInterval: 30
keepAliveMessageInterval: 20
rekeyInterval: 4
rekeyMethod: NEW_TUNNEL
customAttributes:
- anyConnectAttribute: PER_APP_VPN
customAttributeObject:
id: 00505681-162B-0ed3-0000-966367641621
name: custom_attr_2
type: AnyConnectCustomAttribute
sslSettings:
dtlsCompression: DISABLED
ignoreDFBit: false
mtuSize: 1406
sslCompression: DISABLED
description: description
enableIPsecIKEv2Protocol: true
enableSSLProtocol: true
generalSettings:
addressAssignment:
dhcpScope:
id: 00505681-162B-0ed3-0000-536870912003
name: obj
type: Network
ipv4LocalAddressPool:
- id: 00505681-162B-0ed3-0000-476741369859
name: ipv4_pool_1
type: IPv4AddressPool
banner: banner
primaryDNSServer:
id: 00505681-162B-0ed3-0000-536870912021
name: host_1
type: Host
primaryWINSServer:
id: 00505681-162B-0ed3-0000-536870912057
name: host_3
type: Host
secondaryDNSServer:
id: 00505681-162B-0ed3-0000-536870912039
name: host_2
type: Host
secondaryWINSServer:
id: 00505681-162B-0ed3-0000-536870912075
name: host_4
type: Host
splitTunnelSettings:
ipv4SplitTunnelPolicy: TUNNEL_ALL
ipv6SplitTunnelPolicy: TUNNEL_ALL
splitDNSRequestPolicy: USE_SPLIT_TUNNEL_SETTING
name: rest_1
type: GroupPolicy
schema:
$ref: '#/components/schemas/GroupPolicyModel'
type: object
description: Input representation of Group Policy object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/grouppolicies/grouppolicyUUID ( PUT operation for
group policy object )'
: value:
advancedSettings:
restrictVPNToVLANId: 5
sessionSettings:
accessHours:
id: accessHoursUUID
name: timerangehours
type: TimeRange
maxConnectionTimeAlertInterval: 1
maxConnectionTimeout: null
simultaneousLoginPerUser: 3
vpnIdleTimeout: 30
vpnIdleTimeoutAlertInterval: 1
vpnTrafficFilterACL:
id: vpnTrafficFilterACLUUID
name: vpnTrafficfilter
type: ExtendedAccessList
anyConnectSettings:
clientModules:
- enableModuleDownload: false
moduleProfile:
id: vpnClientProfileUUID
name: ampenabler
type: AnyconnectFile
moduleType: AMP_ENABLER
connectionSettings:
bypassUnsupportProtocol: false
clientDPDInterval: 30
clientFirewallPrivateNetworkRules:
id: clientFirewallPrivateNetworkRulesUUID
name: privateNetACL
type: ExtendedAccessList
clientFirewallPublicNetworkRules:
id: clientFirewallPublicNetworkRulesUUID
name: publicNetACL
type: ExtendedAccessList
enableClientDPD: true
enableGatewayDPD: true
enableKeepAliveMessages: true
enableSSLRekey: false
gatewayDPDInterval: 30
keepAliveMessageInterval: 20
rekeyInterval: 4
rekeyMethod: NEW_TUNNEL
customAttributes:
- anyConnectAttribute: PER_APP_VPN
customAttributeObject:
id: customAttributeObjectUUID
name: customAttributeObjectName
type: AnyConnectCustomAttribute
sslSettings:
dtlsCompression: DISABLED
ignoreDFBit: false
mtuSize: 1000
sslCompression: DISABLED
vpnClientProfile:
id: 2d9d6bda-865a-11e8-8472-bb2ae5b3416b
name: remoteaccessprofile
type: AnyconnectFile
description: PUT operation for Group Policy
generalSettings:
addressAssignment:
defaultDomainName: cisco.com
dhcpScope:
id: dhcpScopeUUID
name: dhcpscope
type: Network
ipv4LocalAddressPool:
- id: ipv4LocalAddressPoolUUID
name: ipv4pool1
type: Ipv4AddressPool
banner: This is a sample Banner
primaryDNSServer:
id: primaryDNSServerUUID
name: primarydns
type: Network
primaryWINSServer:
id: primaryWINSServerUUID
name: primarywins
type: Network
secondaryDNSServer:
id: secondaryDNSServerUUID
name: secondarydns
type: Network
secondaryWINSServer:
id: secondaryWINSServerUUID
name: secondarywins
type: Network
splitTunnelSettings:
ipv4SplitTunnelPolicy: TUNNEL_ALL
ipv6SplitTunnelPolicy: TUNNEL_ALL
splitDNSDomainList: SplitACL
splitDNSRequestPolicy: USE_SPLIT_TUNNEL_SETTING
splitTunnelACL:
id: splitTunnelACLUUID
name: splitacl
type: StandardAccessList|ExtendedAccessList
id: f3b4fda4-1e03-11e8-b53e-e7bb7add7360
links:
self: https://fmcip/api/fmc_config/v1/domain/DomainUUID/object/grouppolicies/grouppolicyUUID
metadata: {}
name: PUTGroupPolicy
protocol: SSL
type: GroupPolicy
schema:
$ref: '#/components/schemas/GroupPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/hosts:
delete:
deprecated: false
description: '**Delete all hosts. Use filtering to limit the deleted hosts. _Check the response section for applicable
examples (if any)._**'
operationId: deleteMultipleHostObject
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
"ids:id1,id2,...".ids is a comma-separated list
of rule IDs to be deleted.
in: query
name: filter
required: false
schema:
type: string
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: true
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/object/hosts/hostObject3UUID ( DELETE a host object
for the given UUID )'
: value:
description: Test Description
id: hostObject3UUID
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/hosts/hostObject3UUID
metadata:
domain:
id: GloablDomainUUID
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
name: TestHost
overridable: false
type: Host
value: 10.5.3.28
? 'Example 2 : DELETE /fmc_config/v1/domain/domainUUID/object/hosts/host2_uuid?overrideTargetId=device_uuid
( DELETE a specific host override object )'
: value:
description: ' '
id: host2_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/hosts/host2_uuid?overrideTargetId=device_uuid
metadata:
domain:
id: domainUuid
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
timestamp: 1527150522950.0
name: host2
overridable: true
overrides:
parent:
id: host2_uuid
type: Host
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: Host
value: 1.2.3.5
schema:
$ref: '#/components/schemas/HostObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the list of hosts.**'
operationId: getAllHostObject
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
"ids:id1,id2,...".ids is a comma-separated list
of rule IDs.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/hosts ( Get all paginated host objects )':
value:
items:
- id: hostObject1UUID
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/hosts/hostObject1UUID
name: any-ipv6
type: Host
- id: hostObject2UUID
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/hosts/hostObject2UUID
name: Test1
type: Host
links:
self: /fmc_config/v1/domain/default/object/hosts?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/hosts?expanded=true ( Get all paginated host objects
with expanded set to true )'
: value:
items:
- description: ' '
id: hostObject1UUID
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/hosts/hostObject1UUID
metadata:
domain:
id: GloablDomainUUID
name: Global
ipType: V_6
lastUser:
name: admin
parentType: NetworkAddress
readOnly:
reason: SYSTEM
state: true
name: any-ipv6
overridable: false
type: Host
value: ::/0
- description: ' '
id: hostObject2UUID
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/hosts/hostObject2UUID
metadata:
domain:
id: GloablDomainUUID
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
name: Test1
overridable: false
type: Host
value: 10.5.3.20
links:
self: /fmc_config/v1/domain/default/object/hosts?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 3 : GET /fmc_config/v1/domain/GlobalDomainUUID/object/hosts?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET ALL method from global domain for HostObject when overrides are assigned to child domain
)'
: value:
items:
- description: ' '
id: hostObject2UUID
links:
parent: /fmc_config/v1/domain/GloablDomainUUID/object/networkaddresses
self: /fmc_config/v1/domain/GloablDomainUUID/object/hosts/hostObject2UUID
metadata:
domain:
id: domainUUID
name: Global \ Asia
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
name: pvs_global
overridable: true
overrides:
parent:
id: hostObject2UUID
type: Host
target:
id: domainUUID
name: Global \ Asia
type: Domain
type: Host
value: 1.2.3.4
links:
self: /fmc_config/v1/domain/GloablDomainUUID/object/hosts?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 4 : GET /fmc_config/v1/domain/childDomainUUID/object/hosts?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET ALL method from child domain for HostObject when overrides are assigned to child domain
)'
: value:
items:
- description: ' '
id: hostObject2UUID
links:
parent: /fmc_config/v1/domain/domainUUID/object/networkaddresses
self: /fmc_config/v1/domain/domainUUID/object/hosts/hostObject2UUID
metadata:
domain:
id: domainUUID
name: Global \ Asia
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
name: pvs_global
overridable: true
overrides:
parent:
id: hostObject2UUID
type: Host
target:
id: domainUUID
name: Global \ Asia
type: Domain
type: Host
value: 1.2.3.4
links:
self: /fmc_config/v1/domain/domainUUID/object/hosts?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/HostObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a host. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleHostObject
parameters:
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/hosts ( POST to create a host object )':
value:
description: Test Description
name: TestHost
type: Host
value: 10.5.3.20
'Example 2 : POST /fmc_config/v1/domain/domainUUID/object/hosts?bulk=true ( Bulk POST operation for Host object )':
value:
- description: Test Description
name: host1
type: Host
value: 10.5.3.20
- description: Host object 2
name: Host2
type: Host
value: 1.2.3.4
? 'Example 3 : POST /fmc_config/v1/domain/domainUUID/object/hosts?bulk=true ( Bulk POST operation for Host object
with overrides )'
: value:
- description: ' '
id: host1_uuid
name: host1
overridable: true
overrides:
parent:
id: host1_uuid
name: host1
type: Host
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: Host
value: 10.10.10.10
- description: ' '
id: host1_uuid
name: host1
overridable: true
overrides:
parent:
id: host1_uuid
name: host1
type: Host
target:
id: device_uuid
name: FTDv_R1
type: Device
type: Host
value: 10.10.10.20
'Example 4 : POST /fmc_config/v1/domain/domainUUID/object/hosts ( POST request to create a host object override )':
value:
description: ' '
id: host2_uuid
name: host2
overridable: true
overrides:
parent:
id: host2_uuid
type: Host
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: Host
value: 1.2.3.5
schema:
$ref: '#/components/schemas/HostObject'
type: object
description: Input representation of host object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/hosts ( POST to create a host object )':
value:
id: hostObject3UUID
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/hosts/hostObject3UUID
metadata:
domain:
id: GloablDomainUUID
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
name: TestHost
overridable: false
type: Host
value: 10.5.3.20
'Example 2 : POST /fmc_config/v1/domain/domainUUID/object/hosts?bulk=true ( Bulk POST operation for Host object )':
value:
items:
- description: Test Description
id: host1UUID
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/hosts/host1UUID
metadata:
domain:
id: domainUuid
name: Global
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
timestamp: 0
name: host1
overridable: false
type: Host
value: 10.5.3.20
- description: Host object 2
id: host2UUID
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/hosts/host2UUID
metadata:
domain:
id: domainUuid
name: Global
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
timestamp: 0
name: Host2
overridable: false
type: Host
value: 1.2.3.4
links:
self: /api/fmc_config/v1/domain/domainUuid/object/hosts?bulk=true
? 'Example 3 : POST /fmc_config/v1/domain/domainUUID/object/hosts?bulk=true ( Bulk POST operation for Host
object with overrides )'
: value:
items:
- id: host1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/hosts/host1_uuid
metadata:
domain:
id: domain_uuid
name: Global \ EUROPE
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
timestamp: 0
name: t_host4
overridable: true
overrides:
parent:
id: host1_uuid
type: Host
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: Host
value: 10.10.10.4
- id: host1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/hosts/host1_uuid
metadata:
domain:
id: domain_uuid
name: Global \ ASIA
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
timestamp: 0
name: t_host4
overridable: true
overrides:
parent:
id: host1_uuid
type: Host
target:
id: device_uuid
name: FTDv_R1
type: Device
type: Host
value: 10.10.10.4
links:
self: /api/fmc_config/v1/domain/domainUuid/object/hosts?bulk=true
'Example 4 : POST /fmc_config/v1/domain/domainUUID/object/hosts ( POST request to create a host object override )':
value:
id: host2_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/hosts/00000000-0000-0ed3-0000-008589935903?overrideTargetId=device_uuid
metadata:
domain:
id: domainUuid
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
timestamp: 0
name: host2
overridable: true
overrides:
parent:
id: host2_uuid
type: Host
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: Host
value: 1.2.3.5
schema:
$ref: '#/components/schemas/HostObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/hosts/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all overrides on the host. Response will always be in expanded form. If passed, the "expanded" query
parameter will be ignored.**'
operationId: getAllHostOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/hosts/hostUUID/overrides ( Get all paginated host objects )':
value:
items:
- description: ' '
id: hostUUID
links:
self: /fmc_config/v1/domain/domainUUID/object/hosts/hostUUID?overrideTargetId=targetUUID
metadata:
domain:
id: domainUUID
name: Global \ BENGALURU
lastUser:
name: user1
timestamp: 1520333477540.0
name: Host_1
overridable: true
overrides:
parent:
id: hostUUID
type: Host
target:
id: domainUUID
name: Global \ BENGALURU
type: Domain
type: Host
value: 3.3.3.3
links:
self: /fmc_config/v1/domain/domainUUID/object/hosts/hostUUID/overrides?offset=0&limit=2
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/HostOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/hosts/{containerUUID}/overrides/{objectId}:
get:
deprecated: false
description: '**Get the specified override of host object. Response will always be in expanded form. If passed, the
"expanded" query parameter will be ignored.**'
operationId: getHostOverride
parameters:
- description: Unique identifier of the host override object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HostOverride'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/hosts/{objectId}:
delete:
deprecated: false
description: '**Delete the host associated with the specified ID. _Check the response section for applicable examples
(if any)._**'
operationId: deleteHostObject
parameters:
- description: Unique identifier of the host.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/object/hosts/hostObject3UUID ( DELETE a host object
for the given UUID )'
: value:
description: Test Description
id: hostObject3UUID
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/hosts/hostObject3UUID
metadata:
domain:
id: GloablDomainUUID
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
name: TestHost
overridable: false
type: Host
value: 10.5.3.28
? 'Example 2 : DELETE /fmc_config/v1/domain/domainUUID/object/hosts/host2_uuid?overrideTargetId=device_uuid
( DELETE a specific host override object )'
: value:
description: ' '
id: host2_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/hosts/host2_uuid?overrideTargetId=device_uuid
metadata:
domain:
id: domainUuid
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
timestamp: 1527150522950.0
name: host2
overridable: true
overrides:
parent:
id: host2_uuid
type: Host
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: Host
value: 1.2.3.5
schema:
$ref: '#/components/schemas/HostObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the host associated with the specified ID.**'
operationId: getHostObject
parameters:
- description: Unique identifier of the host.
in: path
name: objectId
required: true
schema:
type: string
- description: Get the overrides associated with the specified host.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/hosts/hostObject3UUID ( GET a host object for the given UUID )':
value:
description: Test Description
id: hostObject3UUID
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/hosts/hostObject3UUID
metadata:
domain:
id: GloablDomainUUID
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
name: TestHost
overridable: false
type: Host
value: 10.5.3.28
? 'Example 2 : GET /fmc_config/v1/domain/GlobalDomainUUID/object/hosts/host_object_uuid?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET method from global domain on a specific HostObject which has override assigned as child
domain )'
: value:
description: ' '
id: hostObject2UUID
links:
parent: /fmc_config/v1/domain/GloablDomainUUID/object/networkaddresses
self: /fmc_config/v1/domain/GloablDomainUUID/object/hosts/hostObject2UUID
metadata:
domain:
id: domainUUID
name: Global \ Asia
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
name: pvs_global
overridable: true
overrides:
parent:
id: hostObject2UUID
type: Host
target:
id: domainUUID
name: Global \ Asia
type: Domain
type: Host
value: 1.2.3.4
? 'Example 3 : GET /fmc_config/v1/domain/childDomainUUID/object/hosts/host_object_uuid?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET method from child domain on a HostObject which has child domain assigned as override
)'
: value:
description: ' '
id: hostObject2UUID
links:
parent: /fmc_config/v1/domain/domainUUID/object/networkaddresses
self: /fmc_config/v1/domain/domainUUID/object/hosts/hostObject2UUID
metadata:
domain:
id: domainUUID
name: Global \ Asia
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
name: pvs_global
overridable: true
overrides:
parent:
id: hostObject2UUID
type: Host
target:
id: domainUUID
name: Global \ Asia
type: Domain
type: Host
value: 1.2.3.4
? 'Example 4 : GET /fmc_config/v1/domain/childDomainUUID/object/hosts/host_object_uuid?expanded=true&overrideTargetId=deviceUUID
( Success: Test GET method from child domain on a HostObject which has device assigned as override )'
: value:
description: ' '
id: hostObjectUUID
links:
parent: /fmc_config/v1/domain/GloablDomainUUID/object/networkaddresses
self: /fmc_config/v1/domain/GloablDomainUUID/object/hosts/hostObjectUUID
metadata:
domain:
id: domainUUID
name: Global \ Asia
ipType: V_4
lastUser:
name: api
parentType: NetworkAddress
name: pvs_global
overridable: true
overrides:
parent:
id: hostObjectUUID
type: Host
target:
id: DeviceUUID
name: 192.168.0.166
type: Device
type: Host
value: 1.2.3.4
schema:
$ref: '#/components/schemas/HostObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the host associated with the specified host. _Check the response section for applicable examples
(if any)._**'
operationId: updateHostObject
parameters:
- description: Unique identifier of the host.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/hosts/hostObject3UUID ( PUT to update a host object )':
value:
description: Test Description
id: hostObject3UUID
name: TestHost
overridable: false
type: Host
value: 10.5.3.28
? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/object/hosts/host2_uuid ( PUT to update override value on
a given host override object )'
: value:
description: ' '
id: host2_uuid
name: host2
overridable: true
overrides:
parent:
id: host2_uuid
type: Host
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: Host
value: 12.2.3.5
schema:
$ref: '#/components/schemas/HostObject'
type: object
description: Input representation of host object.
required: true
responses:
'200':
content:
application/json:
examples:
'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/hosts/hostObject3UUID ( PUT to update a host object )':
value:
id: hostObject3UUID
links:
parent: /fmc_config/v1/domain/default/object/networkaddresses
self: /fmc_config/v1/domain/default/object/hosts/hostObject3UUID
metadata:
domain:
id: GloablDomainUUID
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
name: TestHost
overridable: false
type: Host
value: 10.5.3.28
? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/object/hosts/host2_uuid ( PUT to update override value
on a given host override object )'
: value:
id: host2_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/hosts/00000000-0000-0ed3-0000-008589935903?overrideTargetId=device_uuid
metadata:
domain:
id: domainUuid
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
timestamp: 0
name: host2
overridable: true
overrides:
parent:
id: host2_uuid
type: Host
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: Host
value: 12.2.3.5
schema:
$ref: '#/components/schemas/HostObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/hostscanpackages:
get:
deprecated: false
description: '**Get the list of all host scan packages.**'
operationId: getAllHostScanPackageObject
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/hostscanpackages ( Example for GET ALL operation
of HostScanPackage object )'
: value:
items:
- id: 0050568C-15ED-0ed3-0000-025769803779
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/hostscanpackages/0050568C-15ED-0ed3-0000-025769803779
name: hostscan_4.6.00362-k92.pkg
type: HostScanPackage
- id: 0050568C-15ED-0ed3-0000-004294967311
links:
self: https://u32c01p12-vrouter.cisco.com:8007/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/hostscanpackages/0050568C-15ED-0ed3-0000-004294967311
name: hostscan_4.9.01095-k9.pkg
type: HostScanPackage
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/hostscanpackages?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/HostScanPackageObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a host scan package. _Check the response section for applicable examples (if any)._**'
operationId: createHostScanPackageObject
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
multipart/form-data:
schema:
properties:
description:
description: Provided resource description.
type: string
name:
description: Provided resource name. *required
type: string
payloadFile:
description: Select a Package file. .pkg is the supported file format. *required
format: binary
type: string
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/HostScanPackageObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/hostscanpackages/{objectId}:
delete:
deprecated: false
description: '**Delete the host scan package associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteHostScanPackageObject
parameters:
- description: Unique identifier of the host scan package.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/object/hostscanpackages/objectUUID ( Example for DELETE
operation of HostScanPackage object )'
: value:
description: ' '
fileName: hostscan_4.6.00362-k92.pkg
id: 0050568C-15ED-0ed3-0000-025769803779
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/hostscanpackages/0050568C-15ED-0ed3-0000-025769803779
metadata:
antiMalware:
- id: '200081'
name: ALWIL Software
products:
- id: '200005'
name: avast! Antivirus (Linux)
versions:
- 1.x
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
platformVersions: Win:4_2_1538_0,Mac:4_2_1331_0,Linux:4_2_599_0
timestamp: 1604072511670.0
version: '5_1_2_0'
name: hostscan_4.6.00362-k92.pkg
overridable: false
type: HostScanPackage
schema:
$ref: '#/components/schemas/HostScanPackageObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the host scan package associated with the specified ID.**'
operationId: getHostScanPackageObject
parameters:
- description: Unique identifier of the host scan package.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HostScanPackageObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the host scan package associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateHostScanPackageObject
parameters:
- description: Unique identifier of the host scan package.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
multipart/form-data:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/hostscanpackages/objectUUID ( Example for PUT operation
of HostScanPackage object )'
: value:
description: string
name: string
payloadFile: .pkg file
schema:
properties:
description:
description: Provided resource description.
type: string
id:
description: Unique identifier of the host scan package.
type: string
name:
description: Provided resource name. *required
type: string
payloadFile:
description: Select a Package file. .pkg is the supported file format. *required
format: binary
type: string
type: object
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/hostscanpackages/objectUUID ( Example for PUT operation
of HostScanPackage object )'
: value:
description: ' '
fileName: hostscan_4.6.00362-k92.pkg
id: 0050568C-15ED-0ed3-0000-025769803779
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/hostscanpackages/0050568C-15ED-0ed3-0000-025769803779
metadata:
antiMalware:
- id: '200081'
name: ALWIL Software
products:
- id: '200005'
name: avast! Antivirus (Linux)
versions:
- 1.x
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
platformVersions: Win:4_2_1538_0,Mac:4_2_1331_0,Linux:4_2_599_0
timestamp: 1604072511670.0
version: '5_1_2_0'
name: hostscan_4.6.00362-k92.pkg
overridable: false
type: HostScanPackage
schema:
$ref: '#/components/schemas/HostScanPackageObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/icmpv4objects:
delete:
deprecated: false
description: '**Delete all ICMPv4 objects. Use filtering to limit the deleted ICMPv4 objects. _Check the response section
for applicable examples (if any)._**'
operationId: deleteMultipleICMPV4Object
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: true
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/icmpv4objects/icmpv4Object2UUID ( Test DELETE
of ICMPV4 Object )'
: value:
code: 0
icmpType: '3'
id: icmpv4Object2UUID
name: icmpv4_obj2
type: ICMPV4Object
? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/icmpv4objects/icmpv4_obj1_uuid?overrideTargetId=target_uuid
( DELETE request to remove an override on icmpv4 object )'
: value:
code: 0
description: ' '
icmpType: '3'
id: icmpv4_obj1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv4objects/icmpv4_obj1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 1527350965026.0
name: icmpv4_obj1
overridable: true
overrides:
parent:
id: icmpv4_obj1_uuid
type: ICMPV4Object
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: ICMPV4Object
schema:
$ref: '#/components/schemas/ICMPV4Object'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the list of all ICMPv4 objects.**'
operationId: getAllICMPV4Object
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/icmpv4objects ( Get all paginated icmpv4 objects
without offset and limit )'
: {}
? 'Example 2 : GET /fmc_config/v1/domain/GlobalDomainUUID/object/icmpv4objects?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET ALL method from global domain for ICMPV4Object when overrides are assigned to child
domain )'
: value:
items:
- code: 0
description: ' '
icmpType: '3'
id: icmpv4ObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/ports
self: /fmc_config/v1/domain/global/object/icmpv4objects/icmpv4ObjectUUID
metadata:
domain:
id: childDomainUUID
name: Global \ Asia
lastUser:
name: pvs
parentType: Port
name: pvs_icmpv4
overridable: true
overrides:
parent:
id: icmpv4ObjectUUID
type: ICMPV4Object
target:
id: childDomainUUID
name: Global \ Asia
type: Domain
type: ICMPV4Object
links:
self: /fmc_config/v1/domain/global/object/icmpv4objects?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 3 : GET /fmc_config/v1/domain/childDomainUUID/object/icmpv4objects?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET ALL method from child domain for ICMPV4Object when overrides are assigned to child domain
)'
: value:
items:
- code: 0
description: ' '
icmpType: '3'
id: icmpv4ObjectUUID
links:
parent: https://fmc_host_ip/api/fmc_config/v1/domain/childDomainUUID/object/ports
self: https://fmc_host_ip/api/fmc_config/v1/domain/childDomainUUID/object/icmpv4objects/icmpv4ObjectUUID
metadata:
domain:
id: childDomainUUID
name: Global \ Asia
lastUser:
name: pvs
parentType: Port
name: pvs_icmpv4
overridable: true
overrides:
parent:
id: icmpv4ObjectUUID
type: ICMPV4Object
target:
id: childDomainUUID
name: Global \ Asia
type: Domain
type: ICMPV4Object
links:
self: https://fmc_host_ip/api/fmc_config/v1/domain/childDomainUUID/object/icmpv4objects?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ICMPV4ObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an ICMPv4 object. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleICMPV4Object
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/icmpv4objects ( Test registration of ICMPV4Object
to create a new record )'
: value:
code: 0
icmpType: '3'
name: icmpv4_obj1
type: ICMPV4Object
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/icmpv4objects?bulk=true ( Bulk POST operation on
ICMPV4 objects. )'
: value:
- code: 0
icmpType: '3'
name: icmpv4_obj1
type: ICMPV4Object
- code: 0
icmpType: '4'
name: icmpv4_obj2
type: ICMPV4Object
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/icmpv4objects?bulk=true ( Bulk POST operation on
ICMPV4 objects with overrides )'
: value:
- code: 2
description: ' '
icmpType: '5'
id: icmp4_obj_uuid
name: icmp4_obj
overridable: true
overrides:
parent:
id: icmp4_obj_uuid
type: ICMPV4Object
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: ICMPV4Object
- code: 1
description: ' '
icmpType: '5'
id: icmp4_obj_uuid
name: icmp4_obj
overridable: true
overrides:
parent:
id: icmp4_obj_uuid
type: ICMPV4Object
target:
id: device_uuid
name: FTDv_R1
type: Device
type: ICMPV4Object
? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/icmpv4objects ( POST request to create an override
on ICMPv4 object )'
: value:
code: 0
icmpType: '3'
id: icmpv4_obj1_uuid
name: icmpv4_obj1
overridable: true
overrides:
parent:
id: icmpv4_obj1_uuid
type: ICMPV4Object
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: ICMPV4Object
schema:
$ref: '#/components/schemas/ICMPV4Object'
type: object
description: Input representation of ICMPv4 object.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/icmpv4objects?bulk=true ( Bulk POST operation
on ICMPV4 objects. )'
: value:
items:
- code: 0
description: ' '
icmpType: '3'
id: icmpv4_obj1Uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv4objects/icmpv4_obj1Uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: icmpv4_obj1
overridable: false
type: ICMPV4Object
- code: 0
description: ' '
icmpType: '4'
id: icmpv4_obj2Uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv4objects/icmpv4_obj2Uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: icmpv4_obj2
overridable: false
type: ICMPV4Object
links:
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv4objects?bulk=true
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/icmpv4objects?bulk=true ( Bulk POST operation
on ICMPV4 objects with overrides )'
: value:
items:
- code: 2
icmpType: '5'
id: icmp4_obj_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv4objects/icmp4_obj_uuid
metadata:
domain:
id: domain_uuid
name: Global \ EUROPE
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: icmp4_obj
overridable: true
overrides:
parent:
id: icmp4_obj_uuid
type: ICMPV4Object
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: ICMPV4Object
- code: 1
icmpType: '5'
id: icmp4_obj_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv4objects/icmp4_obj_uuid
metadata:
domain:
id: domain_uuid
name: Global \ ASIA
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: icmp4_obj
overridable: true
overrides:
parent:
id: icmp4_obj_uuid
type: ICMPV4Object
target:
id: device_uuid
name: FTDv_R1
type: Device
type: ICMPV4Object
links:
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv4objects?bulk=true
? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/icmpv4objects ( POST request to create an override
on ICMPv4 object )'
: value:
code: 0
icmpType: '3'
id: icmpv4_obj1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv4objects/icmpv4_obj1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 0
name: icmpv4_obj1
overridable: true
overrides:
parent:
id: icmpv4_obj1_uuid
type: ICMPV4Object
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: ICMPV4Object
schema:
$ref: '#/components/schemas/ICMPV4Object'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/icmpv4objects/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all overrides associated with the ICMPv4 object. Response will always be in expanded form. If passed,
the "expanded" query parameter will be ignored.**'
operationId: getAllICMPV4ObjectOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/icmpv4objects/icmpv4ObjectUUID/overrides ( Get
all (domain and device) overrides on gievn ICMPV4 Object )'
: value:
items:
- description: ' '
icmpType: '3'
id: icmpv4ObjectUUID
links:
self: /fmc_config/v1/domain/domainUUID/object/icmpv4objects/icmpv4ObjectUUID?overrideTargetId=targetUUID
metadata:
domain:
id: domainUUID
name: Global \ INDIA
lastUser:
name: user
parentType: PortObject
timestamp: 1520343093440.0
name: port_1
overridable: true
overrides:
parent:
id: icmpv4ObjectUUID
type: ICMPV4Object
target:
id: targetUUID
name: 10.10.19.25
type: Device
type: ICMPV4Object
links:
self: /fmc_config/v1/domain/domainUUID/object/icmpv4objects/icmpv4ObjectUUID/overrides?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ICMPV4ObjectOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/icmpv4objects/{containerUUID}/overrides/{objectId}:
get:
deprecated: false
description: '**Get the specified override of ICMPv4 object. Response will always be in expanded form. If passed, the
"expanded" query parameter will be ignored.**'
operationId: getICMPV4ObjectOverride
parameters:
- description: Unique identifier of the ICMPv4 override object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ICMPV4ObjectOverride'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/icmpv4objects/{objectId}:
delete:
deprecated: false
description: '**Delete the ICMPv4 object associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteICMPV4Object
parameters:
- description: Unique identifier of the ICMPv4 object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/icmpv4objects/icmpv4Object2UUID ( Test DELETE
of ICMPV4 Object )'
: value:
code: 0
icmpType: '3'
id: icmpv4Object2UUID
name: icmpv4_obj2
type: ICMPV4Object
? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/icmpv4objects/icmpv4_obj1_uuid?overrideTargetId=target_uuid
( DELETE request to remove an override on icmpv4 object )'
: value:
code: 0
description: ' '
icmpType: '3'
id: icmpv4_obj1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv4objects/icmpv4_obj1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 1527350965026.0
name: icmpv4_obj1
overridable: true
overrides:
parent:
id: icmpv4_obj1_uuid
type: ICMPV4Object
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: ICMPV4Object
schema:
$ref: '#/components/schemas/ICMPV4Object'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the ICMPv4 object associated with the specified ID.**'
operationId: getICMPV4Object
parameters:
- description: Unique identifier of the ICMPv4 object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: Get the overrides associated with the specified ICMPv4 object.
in: query
name: overrideTargetId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/icmpv4objects/icmpv4Object1UUID ( Test GET of ICMPV4
Object for a uuid )'
: value:
code: 0
icmpType: '3'
id: icmpv4Object1UUID
name: icmpv4_obj1
type: ICMPV4Object
? 'Example 2 : GET /fmc_config/v1/domain/GlobalDomainUUID/object/icmpv4objects/icmpv4ObjectUUID?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET method from global domain on a specific ICMPV4Object which has override assigned as
child domain )'
: value:
code: 0
description: ' '
icmpType: '3'
id: icmpv4ObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/ports
self: /fmc_config/v1/domain/global/object/icmpv4objects/icmpv4ObjectUUID
metadata:
domain:
id: childDomainUUID
name: Global \ Asia
lastUser:
name: pvs
parentType: Port
name: pvs_icmpv4
overridable: true
overrides:
parent:
id: icmpv4ObjectUUID
type: ICMPV4Object
target:
id: childDomainUUID
name: Global \ Asia
type: Domain
type: ICMPV4Object
? 'Example 3 : GET /fmc_config/v1/domain/childDomainUUID/object/icmpv4objects/icmpv4ObjectUUID?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET method from child domain on a ICMPV4Object which has child domain assigned as override
)'
: value:
code: 0
description: ' '
icmpType: '3'
id: icmpv4ObjectUUID
links:
parent: /fmc_config/v1/domain/childDomainUUID/object/ports
self: /fmc_config/v1/domain/childDomainUUID/object/icmpv4objects/icmpv4ObjectUUID
metadata:
domain:
id: childDomainUUID
name: Global \ Asia
lastUser:
name: pvs
parentType: Port
name: pvs_icmpv4
overridable: true
overrides:
parent:
id: icmpv4ObjectUUID
type: ICMPV4Object
target:
id: childDomainUUID
name: Global \ Asia
type: Domain
type: ICMPV4Object
? 'Example 4 : GET /fmc_config/v1/domain/childDomainUUID/object/icmpv4objects/icmpv4ObjectUUID?expanded=true&overrideTargetId=deviceUUID
( Success: Test GET method from child domain on a ICMPV4Object which has device assigned as override )'
: value:
code: 1
description: ' '
icmpType: '3'
id: icmpv4ObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/ports
self: /fmc_config/v1/domain/global/object/icmpv4objects/icmpv4ObjectUUID
metadata:
domain:
id: domainUUID
name: Global \ Asia
lastUser:
name: api
parentType: Port
name: pvs_icmpv4
overridable: true
overrides:
parent:
id: icmpv4ObjectUUID
type: ICMPV4Object
target:
id: deviceUUID
name: device_name
type: Device
type: ICMPV4Object
schema:
$ref: '#/components/schemas/ICMPV4Object'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the ICMPv4 object associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateICMPV4Object
parameters:
- description: Unique identifier of the ICMPv4 object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/icmpv4objects/icmpv4Object1UUID ( Test PUT of ICMPV4
object to update record )'
: value:
code: 1
icmpType: '3'
id: icmpv4Object1UUID
name: icmpv4_obj1_updated
type: ICMPV4Object
'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/icmpv4objects ( Test PUT of network object to create record )':
value:
code: 0
icmpType: '3'
name: icmpv4_obj2
type: Device
? 'Example 3 : PUT /fmc_config/v1/domain/DomainUUID/object/icmpv4objects/icmpv4_obj1_uuid ( PUT request to update
override on icmpv4 object )'
: value:
code: 0
icmpType: '3'
id: icmpv4_obj1_uuid
name: icmpv4_obj1
overridable: true
overrides:
parent:
id: icmpv4_obj1_uuid
type: ICMPV4Object
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: ICMPV4Object
schema:
$ref: '#/components/schemas/ICMPV4Object'
type: object
description: Input representation of ICMPv4 object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 3 : PUT /fmc_config/v1/domain/DomainUUID/object/icmpv4objects/icmpv4_obj1_uuid ( PUT request to
update override on icmpv4 object )'
: value:
code: 0
icmpType: '3'
id: icmpv4_obj1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv4objects/icmpv4_obj1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 0
name: icmpv4_obj1
overridable: true
overrides:
parent:
id: icmpv4_obj1_uuid
type: ICMPV4Object
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: ICMPV4Object
schema:
$ref: '#/components/schemas/ICMPV4Object'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/icmpv6objects:
delete:
deprecated: false
description: '**Delete all ICMPv6 objects. Use filtering to limit the deleted ICMPv4 objects. _Check the response section
for applicable examples (if any)._**'
operationId: deleteMultipleICMPV6Object
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: true
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/icmpv6objects/icmpv6Object2UUID ( Test DELETE
of ICMPV6 Object )'
: value:
code: 0
icmpType: '3'
id: icmpv6Object2UUID
name: icmpv6_obj2
type: ICMPV6Object
? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/icmpv6objects/icmpv6_obj1_uuid?overrideTargetId=target_uuid
( DELETE request to remove an override on ICMPv6 object )'
: value:
code: 0
description: ' '
icmpType: '3'
id: icmpv6_obj1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv6objects/icmpv6_obj1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 1527357152850.0
name: icmpv6_obj1
overridable: true
overrides:
parent:
id: icmpv6_obj1_uuid
type: ICMPV6Object
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: ICMPV6Object
schema:
$ref: '#/components/schemas/ICMPV6Object'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the list of all ICMPv6 objects.**'
operationId: getAllICMPV6Object
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/icmpv6objects ( Get all paginated icmpv6 objects
without offset and limit )'
: {}
? 'Example 2 : GET /fmc_config/v1/domain/GlobalDomainUUID/object/icmpv6objects?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET ALL method from global domain for ICMPV6Object when overrides are assigned to child
domain )'
: value:
items:
- code: 0
description: ' '
icmpType: '3'
id: icmpv6ObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/ports
self: /fmc_config/v1/domain/global/object/icmpv6objects/icmpv6ObjectUUID
metadata:
domain:
id: childDomainUUID
name: Global \ Asia
lastUser:
name: pvs
parentType: Port
name: pvs_icmpv6
overridable: true
overrides:
parent:
id: icmpv6ObjectUUID
type: ICMPV6Object
target:
id: childDomainUUID
name: Global \ Asia
type: Domain
type: ICMPV6Object
links:
self: /fmc_config/v1/domain/global/object/icmpv6objects?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 3 : GET /fmc_config/v1/domain/childDomainUUID/object/icmpv6objects?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET ALL method from child domain for ICMPV6Object when overrides are assigned to child domain
)'
: value:
items:
- code: 0
description: ' '
icmpType: '3'
id: icmpv6ObjectUUID
links:
parent: /fmc_config/v1/domain/childDomainUUID/object/ports
self: /fmc_config/v1/domain/childDomainUUID/object/icmpv6objects/icmpv6ObjectUUID
metadata:
domain:
id: childDomainUUID
name: Global \ Asia
lastUser:
name: pvs
parentType: Port
name: pvs_icmpv6
overridable: true
overrides:
parent:
id: icmpv6ObjectUUID
type: ICMPV6Object
target:
id: childDomainUUID
name: Global \ Asia
type: Domain
type: ICMPV6Object
links:
self: /fmc_config/v1/domain/childDomainUUID/object/icmpv6objects?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ICMPV6ObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an ICMPv6 object. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleICMPV6Object
parameters:
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/icmpv6objects ( Test registration of ICMPV6Object
to create a new record )'
: value:
code: 0
icmpType: '3'
name: icmpv6_obj1
type: ICMPV6Object
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/icmpv6objects?bulk=true ( Bulk POST operation on
ICMPV6 objects. )'
: value:
- code: 0
icmpType: '3'
name: icmpv6_obj1
type: ICMPV6Object
- code: 0
icmpType: '2'
name: icmpv6_obj2
type: ICMPV6Object
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/icmpv6objects?bulk=true ( Bulk POST operation on
ICMPV6 objects with overrides )'
: value:
- code: 0
description: ' '
icmpType: '2'
id: icmp6_obj_uuid
name: icmp6_obj
overridable: true
overrides:
parent:
id: icmp6_obj_uuid
type: ICMPV6Object
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: ICMPV6Object
- code: 1
description: ' '
icmpType: '3'
id: icmp6_obj_uuid
name: icmp6_obj
overridable: true
overrides:
parent:
id: icmp6_obj_uuid
type: ICMPV6Object
target:
id: device_uuid
name: FTDv_R1
type: Device
type: ICMPV6Object
? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/icmpv6objects ( POST request to create override
on ICMPv6 object )'
: value:
code: 0
icmpType: '3'
id: icmpv6_obj1_uuid
name: icmpv6_obj1
overridable: true
overrides:
parent:
id: icmpv6_obj1_uuid
type: ICMPV6Object
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: ICMPV6Object
schema:
$ref: '#/components/schemas/ICMPV6Object'
type: object
description: The input representation icmpv6 object model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/icmpv6objects?bulk=true ( Bulk POST operation
on ICMPV6 objects. )'
: value:
items:
- code: 0
description: ' '
icmpType: '3'
id: icmpv6_obj1Uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv6objects/icmpv6_obj1Uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: icmpv6_obj1
overridable: false
type: ICMPV6Object
- code: 0
description: ' '
icmpType: '2'
id: icmpv6_obj2Uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv6objects/icmpv6_obj2Uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: icmpv6_obj2
overridable: false
type: ICMPV6Object
links:
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv6objects?bulk=true
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/icmpv6objects?bulk=true ( Bulk POST operation
on ICMPV6 objects with overrides )'
: value:
items:
- code: 0
icmpType: '2'
id: icmp6_obj_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv6objects/icmp6_obj_uuid
metadata:
domain:
id: domain_uuid
name: Global \ EUROPE
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: icmp6_obj
overridable: true
overrides:
parent:
id: icmp6_obj_uuid
type: ICMPV6Object
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: ICMPV6Object
- code: 1
icmpType: '3'
id: icmp6_obj_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv6objects/icmp6_obj_uuid
metadata:
domain:
id: domain_uuid
name: Global \ ASIA
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: icmp6_obj
overridable: true
overrides:
parent:
id: icmp6_obj_uuid
type: ICMPV6Object
target:
id: device_uuid
name: FTDv_R1
type: Device
type: ICMPV6Object
links:
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv6objects?bulk=true
? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/icmpv6objects ( POST request to create override
on ICMPv6 object )'
: value:
code: 0
icmpType: '3'
id: icmpv6_obj1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv6objects/icmpv6_obj1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 0
name: icmpv6_obj1
overridable: true
overrides:
parent:
id: icmpv6_obj1_uuid
type: ICMPV6Object
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: ICMPV6Object
schema:
$ref: '#/components/schemas/ICMPV6Object'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/icmpv6objects/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all overrides associated with the ICMPv6 object. Response will always be in expanded form. If passed,
the "expanded" query parameter will be ignored.**'
operationId: getAllICMPV6ObjectOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/icmpv6objects/icmpv6ObjectUUID/overrides ( Get
all (domain and device) overrides on gievn ICMPV6 Object )'
: value:
items:
- description: ' '
icmpType: '131'
id: icmpv6ObjectUUID
links:
self: /fmc_config/v1/domain/domainUUID/object/icmpv6objects/icmpv6ObjectUUID?overrideTargetId=targetUUID
metadata:
domain:
id: domainUUID
name: Global \ BENGALURU
lastUser:
name: user
parentType: PortObject
timestamp: 1520343130476.0
name: icmp_6
overridable: true
overrides:
parent:
id: icmpv6ObjectUUID
type: ICMPV6Object
target:
id: targetUUID
name: Global \ BENGALURU
type: Domain
type: ICMPV6Object
links:
self: /fmc_config/v1/domain/domainUUID/object/icmpv6objects/icmpv6ObjectUUID/overrides?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ICMPV6ObjectOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/icmpv6objects/{containerUUID}/overrides/{objectId}:
get:
deprecated: false
description: '**Get the specified override of ICMPv6 object. Response will always be in expanded form. If passed, the
"expanded" query parameter will be ignored.**'
operationId: getICMPV6ObjectOverride
parameters:
- description: Unique identifier of the ICMPv6 override object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ICMPV6ObjectOverride'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/icmpv6objects/{objectId}:
delete:
deprecated: false
description: '**Delete the ICMPv6 object associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteICMPV6Object
parameters:
- description: Unique identifier of the ICMPv6 object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/icmpv6objects/icmpv6Object2UUID ( Test DELETE
of ICMPV6 Object )'
: value:
code: 0
icmpType: '3'
id: icmpv6Object2UUID
name: icmpv6_obj2
type: ICMPV6Object
? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/icmpv6objects/icmpv6_obj1_uuid?overrideTargetId=target_uuid
( DELETE request to remove an override on ICMPv6 object )'
: value:
code: 0
description: ' '
icmpType: '3'
id: icmpv6_obj1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv6objects/icmpv6_obj1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 1527357152850.0
name: icmpv6_obj1
overridable: true
overrides:
parent:
id: icmpv6_obj1_uuid
type: ICMPV6Object
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: ICMPV6Object
schema:
$ref: '#/components/schemas/ICMPV6Object'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the ICMPv6 object associated with the specified ID.**'
operationId: getICMPV6Object
parameters:
- description: Unique identifier of the ICMPv6 object.
in: path
name: objectId
required: true
schema:
type: string
- description: Get the overrides associated with the specified ICMPv6 object.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/icmpv6objects/icmpv6ObjectUUID ( Test GET of ICMPV6
Object for a uuid )'
: value:
code: 0
icmpType: '3'
id: icmpv6ObjectUUID
name: icmpv6_obj1
type: ICMPV6Object
? 'Example 2 : GET /fmc_config/v1/domain/GlobalDomainUUID/object/icmpv6objects/icmpv6ObjectUUID?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET method from global domain on a specific ICMPV6Object which has override assigned as
child domain )'
: value:
code: 0
description: ' '
icmpType: '3'
id: icmpv6ObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/ports
self: /fmc_config/v1/domain/global/object/icmpv6objects/icmpv6ObjectUUID
metadata:
domain:
id: childDomainUUID
name: Global \ Asia
lastUser:
name: pvs
parentType: Port
name: pvs_icmpv6
overridable: true
overrides:
parent:
id: icmpv6ObjectUUID
type: ICMPV6Object
target:
id: childDomainUUID
name: Global \ Asia
type: Domain
type: ICMPV6Object
? 'Example 3 : GET /fmc_config/v1/domain/childDomainUUID/object/icmpv6objects/icmpv6ObjectUUID?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET method from child domain on a ICMPV6Object which has child domain assigned as override
)'
: value:
code: 0
description: ' '
icmpType: '3'
id: icmpv6ObjectUUID
links:
parent: /fmc_config/v1/domain/childDomainUUID/object/ports
self: /fmc_config/v1/domain/childDomainUUID/object/icmpv6objects/icmpv6ObjectUUID
metadata:
domain:
id: childDomainUUID
name: Global \ Asia
lastUser:
name: pvs
parentType: Port
name: pvs_icmpv6
overridable: true
overrides:
parent:
id: icmpv6ObjectUUID
type: ICMPV6Object
target:
id: childDomainUUID
name: Global \ Asia
type: Domain
type: ICMPV6Object
? 'Example 4 : GET /fmc_config/v1/domain/childDomainUUID/object/icmpv6objects/icmpv6ObjectUUID?expanded=true&overrideTargetId=deviceUUID
( Success: Test GET method from child domain on a ICMPV6Object which has device assigned as override )'
: value:
code: 0
description: ' '
icmpType: '3'
id: icmpv6ObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/ports
self: /fmc_config/v1/domain/global/object/icmpv6objects/icmpv6ObjectUUID
metadata:
domain:
id: childDomainUUID
name: Global \ Asia
lastUser:
name: api
parentType: Port
name: pvs_icmpv6
overridable: true
overrides:
parent:
id: icmpv6ObjectUUID
type: ICMPV6Object
target:
id: device_uuid
name: device_name
type: Device
type: ICMPV6Object
schema:
$ref: '#/components/schemas/ICMPV6Object'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the ICMPv6 object associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateICMPV6Object
parameters:
- description: Unique identifier of the ICMPv6 object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/icmpv6objects/icmpv6ObjectUUID ( Test PUT of ICMPV6
object to update record )'
: value:
code: 1
icmpType: '3'
id: icmpv6ObjectUUID
name: icmpv6_obj1_updated
type: ICMPV6Object
'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/icmpv6objects ( Test PUT of network object to create record )':
value:
code: 0
icmpType: '3'
name: icmpv6_obj2
type: Device
? 'Example 3 : PUT /fmc_config/v1/domain/DomainUUID/object/icmpv6objects/icmpv6_obj1_uuid ( PUT request to update
override on an ICMPv6 object )'
: value:
code: 0
icmpType: '3'
id: icmpv6_obj1_uuid
name: icmpv6_obj1
overridable: true
overrides:
parent:
id: icmpv6_obj1_uuid
type: ICMPV6Object
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: ICMPV6Object
schema:
$ref: '#/components/schemas/ICMPV6Object'
type: object
description: The input representation icmpv6 object model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 3 : PUT /fmc_config/v1/domain/DomainUUID/object/icmpv6objects/icmpv6_obj1_uuid ( PUT request to
update override on an ICMPv6 object )'
: value:
code: 0
icmpType: '3'
id: icmpv6_obj1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/icmpv6objects/icmpv6_obj1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 0
name: icmpv6_obj1
overridable: true
overrides:
parent:
id: icmpv6_obj1_uuid
type: ICMPV6Object
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: ICMPV6Object
schema:
$ref: '#/components/schemas/ICMPV6Object'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ikev1ipsecproposals:
get:
deprecated: false
description: '**Get the list of all IKEv1 IPSec Proposals.**'
operationId: getAllIKEv1IPsecProposal
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals?limit=2 ( Get all paginated
ikev1ipsecproposal objects with limit set 2 )'
: value:
items:
- id: ikev1ipsecproposalUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID
name: ikev1ipsecproposal-1
type: IKEv1IPsecProposal
- id: ikev1ipsecproposalUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID
name: ikev1ipsecproposal-2
type: IKEv1IPsecProposal
links:
self: /fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals?limit=2&expanded=true ( Get
all paginated ikev1 ipsec proposal objects with limit set 2 )'
: value:
items:
- description: IKEv1 IPsec object description
espEncryption: AES-192
espHash: SHA
id: ikev1ipsecproposalUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID
name: ikev1ipsecproposal-1
type: IKEv1IPsecProposal
- description: IKEv1 IPsec object description
espEncryption: DES
espHash: MD5
id: ikev1ipsecproposalUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID
name: ikev1ipsecproposal-2
type: IKEv1IPsecProposal
links:
self: /fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/IKEv1IPsecProposalListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an IKEv1 IPSec Proposal. _Check the response section for applicable examples (if any)._**'
operationId: createIKEv1IPsecProposal
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals ( POST method for IKEv1 IPsec Proposal )':
value:
description: IKEv1 IPsec object description
espEncryption: DES
espHash: MD5
id: ikev1ipsecproposalUUID
name: ikev1ipsecproposal-test-1
schema:
$ref: '#/components/schemas/IKEv1IPsecProposal'
type: object
description: Input representation of IKEv1 IPSec Proposal object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals ( POST method for IKEv1 IPsec Proposal )':
value:
description: IKEv1 IPsec object description
espEncryption: DES
espHash: MD5
id: ikev1ipsecproposalUUID
links:
parent: /api/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID
name: ikev1ipsecproposal-test-1
type: IKEv1IPsecProposal
schema:
$ref: '#/components/schemas/IKEv1IPsecProposal'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ikev1ipsecproposals/{objectId}:
delete:
deprecated: false
description: '**Delete the IKEv1 IPSec Proposal associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteIKEv1IPsecProposal
parameters:
- description: Unique identifier for the IKEv1 IPSec Proposal.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID (
DELETE method for IKEv1 IPsec Proposal )'
: value:
description: IKEv1 IPsec object description
espEncryption: DES
espHash: MD5
id: ikev1ipsecproposalUUID
links:
parent: /api/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID
name: ikev1ipsecproposal-test-1
type: IKEv1IPsecProposal
schema:
$ref: '#/components/schemas/IKEv1IPsecProposal'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the IKEv1 IPSec Proposal associated with the specified ID.**'
operationId: getIKEv1IPsecProposal
parameters:
- description: Unique identifier for the IKEv1 IPSec Proposal.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID ( Get
ikev1 ipsec proposal object by id )'
: value:
description: IKEv1 IPsec Proposal object description
espEncryption: AES-192
espHash: NONE
id: ikev1ipsecproposalUUID
links:
self: /fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID
name: ikev1ipsecproposal-1
type: IKEv1IPsecProposal
schema:
$ref: '#/components/schemas/IKEv1IPsecProposal'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the IKEv1 IPSec Proposal associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateIKEv1IPsecProposal
parameters:
- description: Unique identifier for the IKEv1 IPSec Proposal.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID ( PUT
method for IKEv1 IPsec Proposal )'
: value:
description: IKEv1 IPsec object description
espEncryption: DES
espHash: NONE
id: ikev1ipsecproposalUUID
name: ikev1ipsecproposal-test-1
schema:
$ref: '#/components/schemas/IKEv1IPsecProposal'
type: object
description: Input representation of IKEv1 IPSec Proposal object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID ( PUT
method for IKEv1 IPsec Proposal )'
: value:
description: IKEv1 IPsec object description
espEncryption: DES
espHash: MD5
id: ikev1ipsecproposalUUID
links:
parent: /api/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1ipsecproposals/ikev1ipsecproposalUUID
name: ikev1ipsecproposal-test-1
type: IKEv1IPsecProposal
schema:
$ref: '#/components/schemas/IKEv1IPsecProposal'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ikev1policies:
get:
deprecated: false
description: '**Get the list of all IKEv1 policies.**'
operationId: getAllIkev1PolicyObject
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/ikev1policies?limit=2 ( Get all paginated ikev1policy
objects with limit set 2 )'
: value:
items:
- id: ikev1policyUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID
name: ikev1policy-1
type: IKEv1Policy
- id: ikev1policyUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID
name: ikev1policy-2
type: IKEv1Policy
links:
self: /fmc_config/v1/domain/DomainUUID/object/ikev1policies?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/ikev1policies?limit=2&expanded=true ( Get all paginated
ikev1 policy objects with limit set 2 and expanded is set to true )'
: value:
items:
- authenticationMethod: Preshared Key
description: IKEv1 Policy object description
diffieHellmanGroup: 5
encryption: AES-128
hash: SHA
id: ikev1policyUUID
lifetimeInSeconds: 86400
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID
name: ikev1policy-1
priority: 20
type: IKEv1Policy
- authenticationMethod: Preshared Key
description: IKEv1 Policy object description
diffieHellmanGroup: 5
encryption: AES-128
hash: SHA
id: ikev1policyUUID
lifetimeInSeconds: 86400
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID
name: ikev1policy-2
priority: 20
type: IKEv1Policy
links:
self: /fmc_config/v1/domain/DomainUUID/object/ikev1policies?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/Ikev1PolicyObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an IKEv1 policy. _Check the response section for applicable examples (if any)._**'
operationId: createIkev1PolicyObject
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/ikev1policies ( POST method for IKEv1 Policy Object )':
value:
authenticationMethod: Preshared Key
description: IKEv1 Policy object description
diffieHellmanGroup: 5
encryption: AES-128
hash: SHA
lifetimeInSeconds: 86400
name: ikev1policy-test-1
priority: 20
type: IKEv1Policy
schema:
$ref: '#/components/schemas/Ikev1PolicyObject'
type: object
description: Input representation of IKEv1 policy object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/ikev1policies ( POST method for IKEv1 Policy Object )':
value:
authenticationMethod: Preshared Key
description: IKEv1 Policy object description
diffieHellmanGroup: 5
encryption: AES-128
hash: SHA
id: ikev1policyUUID
lifetimeInSeconds: 86400
links:
parent: /api/fmc_config/v1/domain/DomainUUID/object/ikev1policies
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID
name: ikev1policy-test-1
priority: 20
type: IKEv1Policy
schema:
$ref: '#/components/schemas/Ikev1PolicyObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ikev1policies/{objectId}:
delete:
deprecated: false
description: '**Delete the IKEv1 policy associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteIkev1PolicyObject
parameters:
- description: Unique identifier for the IKEv1 policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID ( DELETE method
for IKEv1 Policy )'
: value:
authenticationMethod: Preshared Key
description: IKEv1 Policy object description
diffieHellmanGroup: 5
encryption: AES-128
hash: SHA
id: ikev1policyUUID
lifetimeInSeconds: 86400
links:
parent: /api/fmc_config/v1/domain/DomainUUID/object/ikev1policies
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID
name: ikev1policy-test-1
priority: 20
type: IKEv1Policy
schema:
$ref: '#/components/schemas/Ikev1PolicyObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the IKEv1 policy associated with the specified ID.**'
operationId: getIkev1PolicyObject
parameters:
- description: Unique identifier for the IKEv1 policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID ( Get ikev1 policy object by id )':
value:
authenticationMethod: Preshared Key
description: Get ikev1 policy object by id
diffieHellmanGroup: 5
encryption: AES-128
hash: SHA
id: ikev1policyUUID
lifetimeInSeconds: 86400
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID
name: ikev1_object
priority: 20
type: IKEv1Policy
schema:
$ref: '#/components/schemas/Ikev1PolicyObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the IKEv1 policy associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateIkev1PolicyObject
parameters:
- description: Unique identifier for the IKEv1 policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID ( PUT method for IKEv1 Policy )':
value:
authenticationMethod: Preshared Key
description: IKEv1 Policy object description
diffieHellmanGroup: 5
encryption: AES-128
hash: SHA
id: ikev1policyUUID
lifetimeInSeconds: 86400
name: ikev1policy-test-1
priority: 20
type: IKEv1Policy
schema:
$ref: '#/components/schemas/Ikev1PolicyObject'
type: object
description: Input representation of IKEv1 policy object.
required: true
responses:
'200':
content:
application/json:
examples:
'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID ( PUT method for IKEv1 Policy )':
value:
authenticationMethod: Preshared Key
description: IKEv1 Policy object description
diffieHellmanGroup: 5
encryption: AES-128
hash: SHA
id: ikev1policyUUID
lifetimeInSeconds: 86400
links:
parent: /api/fmc_config/v1/domain/DomainUUID/object/ikev1policies
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev1policies/ikev1policyUUID
name: ikev1policy-test-1
priority: 20
type: IKEv1Policy
schema:
$ref: '#/components/schemas/Ikev1PolicyObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ikev2ipsecproposals:
get:
deprecated: false
description: '**Get the list of all IKEv2 IPSec Proposals.**'
operationId: getAllIKEv2IPsecProposal
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals?limit=2 ( Get all paginated
ikev2ipsecproposal objects with limit set 2 )'
: value:
items:
- id: ikev2ipsecproposalUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID
name: ikev2ipsecproposal-1
type: IKEv2IPsecProposal
- id: ikev2ipsecproposalUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID
name: ikev2ipsecproposal-2
type: IKEv2IPsecProposal
links:
self: /fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals?limit=2&expanded=true ( Get
all paginated ikev2 ipsec proposal objects with limit set 2 )'
: value:
items:
- description: IKEv2 IPsec object description
encryptionAlgorithms:
- 3DES
- AES-192
id: ikev2ipsecproposalUUID
integrityAlgorithms:
- SHA-256
- SHA-512
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID
name: ikev2ipsecproposal-1
type: IKEv2IPsecProposal
- description: IKEv2 IPsec object description
encryptionAlgorithms:
- 3DES
- AES-192
id: ikev2ipsecproposalUUID
integrityAlgorithms:
- SHA-256
- SHA-512
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID
name: ikev2ipsecproposal-2
type: IKEv2IPsecProposal
links:
self: /fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/IKEv2IPsecProposalListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an IKEv2 IPSec Proposal. _Check the response section for applicable examples (if any)._**'
operationId: createIKEv2IPsecProposal
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals ( POST method for IKEv2 IPsec Proposal )':
value:
description: IKEv2 IPsec object description
encryptionAlgorithms:
- 3DES
- AES-192
id: ikev2ipsecproposalUUID
integrityAlgorithms:
- SHA-256
- SHA-512
name: ikev2ipsecproposal-test-1
type: IKEv2IPsecProposal
schema:
$ref: '#/components/schemas/IKEv2IPsecProposal'
type: object
description: Input representation of IKEv2 IPSec Proposal object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals ( POST method for IKEv2 IPsec Proposal )':
value:
description: IKEv2 IPsec object description
encryptionAlgorithms:
- 3DES
- AES-192
id: ikev2ipsecproposalUUID
integrityAlgorithms:
- SHA-256
- SHA-512
links:
parent: /api/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID
name: ikev2ipsecproposal-test-1
type: IKEv2IPsecProposal
schema:
$ref: '#/components/schemas/IKEv2IPsecProposal'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ikev2ipsecproposals/{objectId}:
delete:
deprecated: false
description: '**Delete the IKEv2 IPSec Proposal associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteIKEv2IPsecProposal
parameters:
- description: Unique identifier for the IKEv2 IPSec Proposal.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID (
DELETE method for IKEv2 IPsec Proposal )'
: value:
description: IKEv2 IPsec object description
encryptionAlgorithms:
- 3DES
- AES-192
id: ikev2ipsecproposalUUID
integrityAlgorithms:
- SHA-256
- SHA-512
links:
parent: /api/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID
name: ikev2ipsecproposal-test-1
type: IKEv2IPsecProposal
schema:
$ref: '#/components/schemas/IKEv2IPsecProposal'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the IKEv2 IPSec Proposal associated with the specified ID.**'
operationId: getIKEv2IPsecProposal
parameters:
- description: Unique identifier for the IKEv2 IPSec Proposal.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID ( Get
ikev1 ipsec proposal object by id )'
: value:
description: IKEv2 IPsec Proposal object description
encryptionAlgorithms:
- 3DES
- AES-192
id: ikev2ipsecproposalUUID
integrityAlgorithms:
- SHA-256
- SHA-512
links:
self: /fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID
name: ikev2ipsecproposal-1
type: IKEv2IPsecProposal
schema:
$ref: '#/components/schemas/IKEv2IPsecProposal'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the IKEv2 IPSec Proposal associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateIKEv2IPsecProposal
parameters:
- description: Unique identifier for the IKEv2 IPSec Proposal.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID ( PUT
method for IKEv2 IPsec Proposal )'
: value:
description: IKEv2 IPsec object description
encryptionAlgorithms:
- 3DES
id: ikev2ipsecproposalUUID
integrityAlgorithms:
- SHA-256
name: ikev2ipsecproposal-test-1
type: IKEv2IPsecProposal
schema:
$ref: '#/components/schemas/IKEv2IPsecProposal'
type: object
description: Input representation of IKEv2 IPSec Proposal object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID ( PUT
method for IKEv2 IPsec Proposal )'
: value:
description: IKEv1 IPsec object description
encryptionAlgorithms:
- 3DES
id: ikev2ipsecproposalUUID
integrityAlgorithms:
- SHA-256
links:
parent: /api/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev2ipsecproposals/ikev2ipsecproposalUUID
name: ikev2ipsecproposal-test-1
type: IKEv2IPsecProposal
schema:
$ref: '#/components/schemas/IKEv2IPsecProposal'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ikev2policies:
get:
deprecated: false
description: '**Get the list of all IKEv2 policies.**'
operationId: getAllIkev2PolicyObject
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/ikev2policies?expanded=true ( Get all paginated
Ikev2 objects with expanded set to true )'
: value:
expectHeaderContains:
- content-type: application/json
expectStatus: 200
items:
- description: ' '
diffieHellmanGroups:
- 5
- 14
- 19
- 20
- 21
encryptionAlgorithms:
- AES-GCM
- AES-GCM-192
- AES-GCM-256
id: 005056A9-5C7D-0ed3-0000-000000000400
integrityAlgorithms:
- 'NULL'
lifetimeInSeconds: 86400
links:
self: https:///api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/ikev2policies/005056A9-5C7D-0ed3-0000-000000000400
name: AES-GCM-NULL-SHA
prfIntegrityAlgorithms:
- SHA
- SHA-256
- SHA-384
- SHA-512
priority: 10
type: Ikev2Policy
- description: ' '
diffieHellmanGroups:
- 5
- 14
- 20
- 21
- 24
encryptionAlgorithms:
- AES
- AES-192
- AES-256
id: 005056A9-5C7D-0ed3-0000-000000000401
integrityAlgorithms:
- SHA
- SHA-256
- SHA-384
- SHA-512
lifetimeInSeconds: 86400
links:
self: https:///api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/ikev2policies/005056A9-5C7D-0ed3-0000-000000000401
name: AES-SHA-SHA
prfIntegrityAlgorithms:
- SHA
- SHA-256
- SHA-384
- SHA-512
priority: 20
type: Ikev2Policy
- description: ' '
diffieHellmanGroups:
- 5
- 14
- 19
- 20
- 21
encryptionAlgorithms:
- AES-GCM
- AES-GCM-192
- AES-GCM-256
id: 005056A9-5C7D-0ed3-0000-081604378664
integrityAlgorithms:
- 'NULL'
lifetimeInSeconds: 86400
links:
self: https:///api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/ikev2policies/005056A9-5C7D-0ed3-0000-081604378664
name: api_ike2
prfIntegrityAlgorithms:
- SHA
- SHA-256
- SHA-384
- SHA-512
priority: 10
type: Ikev2Policy
- description: ' '
diffieHellmanGroups:
- 5
encryptionAlgorithms:
- DES
id: 005056A9-5C7D-0ed3-0000-000000000402
integrityAlgorithms:
- SHA
lifetimeInSeconds: 86400
links:
self: https:///api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/ikev2policies/005056A9-5C7D-0ed3-0000-000000000402
name: DES-SHA-SHA
prfIntegrityAlgorithms:
- SHA
priority: 80
type: Ikev2Policy
links:
self: /fmc_config/v1/domain/default/object/ikev2policies?expanded=true
paging:
count: 4
limit: 4
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/Ikev2PolicyObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an IKEv2 policy. _Check the response section for applicable examples (if any)._**'
operationId: createIkev2PolicyObject
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/ikev2policies ( POST to create a Ikev2 object )':
value:
description: ' '
diffieHellmanGroups:
- 5
- 14
- 19
- 20
- 21
encryptionAlgorithms:
- AES-GCM
- AES-GCM-192
- AES-GCM-256
integrityAlgorithms:
- 'NULL'
lifetimeInSeconds: 86400
name: api_ike33
prfIntegrityAlgorithms:
- SHA
- SHA-256
- SHA-384
- SHA-512
priority: 12
type: Ikev2Policy
schema:
$ref: '#/components/schemas/Ikev2PolicyObject'
type: object
description: Identifier for IKEv2 monitor object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/ikev2policies ( POST to create a Ikev2 object )':
value:
description: ' '
diffieHellmanGroups:
- 5
- 14
- 19
- 20
- 21
encryptionAlgorithms:
- AES-GCM
- AES-GCM-192
- AES-GCM-256
id: 005056A9-5C7D-0ed3-0000-081604379456
integrityAlgorithms:
- 'NULL'
lifetimeInSeconds: 86400
links:
self: https:///api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/ikev2policies/005056A9-5C7D-0ed3-0000-081604379456
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
lastUser:
name: gp1
timestamp: 0
name: api_ike33
prfIntegrityAlgorithms:
- SHA
- SHA-256
- SHA-384
- SHA-512
priority: 12
type: Ikev2Policy
schema:
$ref: '#/components/schemas/Ikev2PolicyObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ikev2policies/{objectId}:
delete:
deprecated: false
description: '**Delete the IKEv2 policy associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteIkev2PolicyObject
parameters:
- description: Unique identifier for the IKEv2 policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/ikev2policies/ikev2MonitorObjectUUID ( DELETE
method for Ikev2 Monitor Object )'
: value:
diffieHellmanGroups:
- 5
- 14
- 19
- 20
- 21
encryptionAlgorithms:
- AES-GCM
- AES-GCM-192
- AES-GCM-256
id: 005056A9-5C7D-0ed3-0000-081604379285
integrityAlgorithms:
- 'NULL'
lifetimeInSeconds: 86400
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ikev2policies/ikev2ObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
lastUser:
name: gp1
timestamp: 1517283234730.0
name: api_ike22
prfIntegrityAlgorithms:
- SHA
- SHA-256
- SHA-384
- SHA-512
priority: 12
type: Ikev2Policy
schema:
$ref: '#/components/schemas/Ikev2PolicyObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the IKEv2 policy associated with the specified ID.**'
operationId: getIkev2PolicyObject
parameters:
- description: Unique identifier for the IKEv2 policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/ikev2policies ( null )':
value:
items:
- id: ikev2Object1UUID
links:
self: /fmc_config/v1/domain/default/object/ikev2policies/ikev2Object1UUID
name: ikev2_test
type: Ikev2Policy
- id: ikev2Object2UUID
links:
self: /fmc_config/v1/domain/default/object/ikev2policies/ikev2Object2UUID
name: ikev2_test2
type: Ikev2Policy
links:
self: /fmc_config/v1/domain/default/object/ikev2policies?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/Ikev2PolicyObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the IKEv2 policy associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateIkev2PolicyObject
parameters:
- description: Unique identifier for the IKEv2 policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/ikev2policies/ikev2Object3UUID ( PUT to update a Ikev2 object )':
value:
description: ' '
diffieHellmanGroups:
- 5
- 14
- 19
- 20
- 21
encryptionAlgorithms:
- AES-GCM
- AES-GCM-192
- AES-GCM-256
id: 005056A9-5C7D-0ed3-0000-081604379285
integrityAlgorithms:
- 'NULL'
lifetimeInSeconds: 86400
name: api_ike22
prfIntegrityAlgorithms:
- SHA
- SHA-256
- SHA-384
- SHA-512
priority: 12
type: Ikev2Policy
schema:
$ref: '#/components/schemas/Ikev2PolicyObject'
type: object
description: Identifier for IKEv2 monitor object.
required: true
responses:
'200':
content:
application/json:
examples:
'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/ikev2policies/ikev2Object3UUID ( PUT to update a Ikev2 object )':
value:
description: ' '
diffieHellmanGroups:
- 5
- 14
- 19
- 20
- 21
encryptionAlgorithms:
- AES-GCM
- AES-GCM-192
- AES-GCM-256
id: 005056A9-5C7D-0ed3-0000-081604379285
integrityAlgorithms:
- 'NULL'
lifetimeInSeconds: 86400
links:
self: https:///api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/ikev2policies/005056A9-5C7D-0ed3-0000-081604379285
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
lastUser:
name: gp1
timestamp: 0
name: api_ike22
prfIntegrityAlgorithms:
- SHA
- SHA-256
- SHA-384
- SHA-512
priority: 12
type: Ikev2Policy
schema:
$ref: '#/components/schemas/Ikev2PolicyObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/interfacegroups:
get:
deprecated: false
description: '**Get the list of all interface groups.**'
operationId: getAllInterfaceGroupObject
parameters:
- description: Query Param to return interface groups of specified InterfaceModeIG type based on the filter. Value is
of format interfaceMode:ROUTED or interfaceMode:PASSIVE or interfaceMode:INLINE or interfaceMode:SWITCHED
or interfaceMode:MANAGEMENT or interfaceMode:LOOPBACK.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/interfacegroups ( Get all paginated interfacegroup objects )':
value:
items:
- id: Interface-group-UUID-2
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/
self: https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfacegroups/Interface-group-UUID-2
name: Test2
type: InterfaceGroup
- id: Interface-group-UUID-3
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/
self: https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfacegroups/Interface-group-UUID-3
name: Test1
type: InterfaceGroup
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfacegroups?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/interfacegroups?expanded=true ( Get all paginated
interfacegroup objects expanded=true )'
: value:
items:
- id: Interface-group-UUID-2
interfaceMode: ASA
interfaces:
- id: Intf-UUID-3
name: outside
type: FPPhysicalInterface
- id: Intf-UUID-4
name: inside
type: FPPhysicalInterface
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/
self: https://vienna.cisco.com/api/fmc_config/v1/domain/default/object/interfacegroups/Interface-group-UUID-2
metadata:
domain:
id: domainUUID
name: Global
type: domain
lastUser:
id: User-UUID
name: admin
type: user
parentType: InterfaceObject
readOnly:
state: true
timestamp: 1459973987.0
name: Test2
type: InterfaceGroup
- id: Interface-group-UUID-3
interfaceMode: INLINE
interfaces:
- id: Intf-UUID-5
name: s1p2
type: FPPhysicalInterface
- id: Intf-UUID-6
name: s1p1
type: FPPhysicalInterface
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/
self: https://vienna.cisco.com/api/fmc_config/v1/domain/default/object/interfacegroups/Interface-group-UUID-3
metadata:
domain:
id: domainUUID
name: Global
type: domain
lastUser:
id: User-UUID
name: admin
type: user
parentType: InterfaceObject
readOnly:
state: true
timestamp: 1459973857.0
name: Test1
type: InterfaceGroup
links:
self: https://vienna.cisco.com/api/fmc_config/v1/domain/default/object/interfacegroups?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/InterfaceGroupObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an interface group. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleInterfaceGroupObject
parameters:
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/interfacegroups ( POST method for interface group object )':
value:
interfaceMode: INLINE
interfaces:
- id: Intf-UUID-1
name: eth1
type: PhysicalInterface
- id: Intf-UUID-2
name: eth2
type: PhysicalInterface
name: InterfaceGroupObject5
type: InterfaceGroup
? 'Example 2 : POST /fmc_config/v1/domain/domainUUID/object/interfacegroups?bulk=true ( bulk POST method for
interface groups )'
: value:
- interfaceMode: ROUTED
interfaces:
- id: Intf-UUID-1
name: eth1
type: PhysicalInterface
- id: Intf-UUID-2
name: eth2
type: PhysicalInterface
name: IG1
type: InterfaceGroup
- interfaceMode: ROUTED
interfaces:
- id: Intf-UUID-3
name: eth3
type: PhysicalInterface
- id: Intf-UUID-4
name: eth4
type: PhysicalInterface
name: IG2
type: InterfaceGroup
schema:
$ref: '#/components/schemas/InterfaceGroupObject'
type: object
description: The input representation of interface group object model.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/interfacegroups ( POST method for interface group object )':
value:
id: Interface-group-UUID-1
interfaceMode: INLINE
interfaces:
- id: Intf-UUID-1
name: eth1
type: PhysicalInterface
- id: Intf-UUID-2
name: eth2
type: PhysicalInterface
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfacegroups/Interface-group-UUID-1
metadata:
domain:
id: domainUUID
name: Global
type: Domain
lastUser:
id: User-UUID
name: admin
type: User
parentType: InterfaceObject
readOnly:
state: true
timestamp: 1459973987.0
name: InterfaceGroupObject5
type: InterfaceGroup
? 'Example 2 : POST /fmc_config/v1/domain/domainUUID/object/interfacegroups?bulk=true ( bulk POST method for
interface groups )'
: value:
items:
- id: IG1_UUID
interfaceMode: ROUTED
interfaces:
- id: Intf-UUID-1
name: eth1
type: PhysicalInterface
- id: Intf-UUID-2
name: eth2
type: PhysicalInterface
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfacegroups/IG1_UUID
metadata:
domain:
id: domainUUID
name: Global
type: domain
lastUser:
id: User-UUID
name: admin
type: user
parentType: InterfaceObject
readOnly:
state: true
timestamp: 1518506949.0
name: IG1
type: InterfaceGroup
- id: IG2_UUID
interfaceMode: ROUTED
interfaces:
- id: Intf-UUID-3
name: eth3
type: PhysicalInterface
- id: Intf-UUID-4
name: eth4
type: PhysicalInterface
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfacegroups/IG2_UUID
metadata:
domain:
id: domainUUID
name: Global
type: domain
lastUser:
id: User-UUID
name: admin
type: user
parentType: InterfaceObject
readOnly:
state: true
timestamp: 1518506949.0
name: IG2
type: InterfaceGroup
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfacegroups?bulk=true
schema:
$ref: '#/components/schemas/InterfaceGroupObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/interfacegroups/{objectId}:
delete:
deprecated: false
description: '**Delete the interface group associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteInterfaceGroupObject
parameters:
- description: Unique identifier of the interface group.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/object/interfacegroups/Interface-group-UUID-1 ( DELETE
method for interface group object )'
: value:
id: Interface-group-UUID-1
interfaceMode: INLINE
interfaces:
- id: Intf-UUID-1
name: eth1
type: FPPhysicalInterface
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfacegroups/Interface-group-UUID-1
metadata:
domain:
id: domainUUID
name: Global
type: Domain
lastUser:
id: User-UUID
name: admin
type: User
parentType: InterfaceObject
readOnly:
state: true
timestamp: 1459973987.0
name: InterfaceGroupObject5
type: InterfaceGroup
schema:
$ref: '#/components/schemas/InterfaceGroupObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the interface group associated with the specified ID.**'
operationId: getInterfaceGroupObject
parameters:
- description: Unique identifier of the interface group.
in: path
name: objectId
required: true
schema:
type: string
- description: Boolean indicating whether to group by devices rather than by interfaces.
in: query
name: groupByDevice
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/interfacegroups/Interface-group-UUID-1 ( GET method
for interface group object by UUID )'
: value:
id: Interface-group-UUID-1
interfaceMode: INLINE
interfaces:
- id: Intf-UUID-1
name: eth1
type: FPPhysicalInterface
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfacegroups/Interface-group-UUID-1
metadata:
domain:
id: domainUUID
name: Global
type: Domain
lastUser:
id: User-UUID
name: admin
type: User
readOnly:
state: true
timestamp: 1459973987.0
name: InterfaceGroupObject5
type: InterfaceGroup
schema:
$ref: '#/components/schemas/InterfaceGroupObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the interface group associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateInterfaceGroupObject
parameters:
- description: Unique identifier of the interface group.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/interfacegroups/Interface-group-UUID-1 ( PUT method
for interface group object )'
: value:
id: Interface-group-UUID-1
interfaceMode: INLINE
interfaces:
- id: Intf-UUID-1
name: eth1
type: FPPhysicalInterface
name: InterfaceGroupObject5
type: InterfaceGroup
schema:
$ref: '#/components/schemas/InterfaceGroupObject'
type: object
description: The input representation of interface group object model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/interfacegroups/Interface-group-UUID-1 ( PUT method
for interface group object )'
: value:
id: Interface-group-UUID-1
interfaceMode: INLINE
interfaces:
- deviceId: 6aea9a46-d256-11e5-9f49-a0e56e5a9137
id: Intf-UUID-1
name: eth1
type: FPPhysicalInterface
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfaceobjects/
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/interfacegroups/Interface-group-UUID-1
metadata:
domain:
id: domainUUID
name: Global
type: Domain
lastUser:
id: User-UUID
name: admin
type: User
parentType: InterfaceObject
readOnly:
state: true
timestamp: 1459973987.0
name: InterfaceGroupObject5
type: InterfaceGroup
schema:
$ref: '#/components/schemas/InterfaceGroupObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/interfaceobjects:
get:
deprecated: false
description: '**Get the list of all security zones and interface groups.**'
operationId: getAllInterfaceObject
parameters:
- description: Query Param to return security zones and interface groups of specified InterfaceMode type based on the
filter. The interface mode type passed should be common to both security zones and interface groups. Value is of
format interfaceMode:ROUTED or interfaceMode:PASSIVE or interfaceMode:INLINE or interfaceMode:SWITCHED.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/interfaceobjects ( Get all paginated interface objects )':
value:
items:
- id: Interface-obj-UUID-2
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfaceobjects/Interface-obj-UUID-2
name: Test2
type: InterfaceGroup
- id: Interface-obj-UUID-3
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfaceobjects/
self: https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfacegroups/Interface-obj-UUID-3
name: Test1
type: InterfaceGroup
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfaceobjects?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/interfaceobjects?expanded=true ( Get all paginated
interfaceobject objects expanded=true )'
: value:
items:
- id: Interface-obj-UUID-2
interfaceMode: ASA
interfaces:
- id: Intf-UUID-3
name: outside
type: FPPhysicalInterface
- id: Intf-UUID-4
name: inside
type: FPPhysicalInterface
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfaceobjects/
self: https://vienna.cisco.com/api/fmc_config/v1/domain/default/object/interfacegroups/Interface-obj-UUID-2
metadata:
domain:
id: domainUUID
name: Global
type: domain
lastUser:
id: User-UUID
name: admin
type: user
readOnly:
state: true
timestamp: 1459973987.0
name: Test2
type: InterfaceGroup
- id: Interface-obj-UUID-3
interfaceMode: INLINE
interfaces:
- id: Intf-UUID-5
name: s1p2
type: FPPhysicalInterface
- id: Intf-UUID-6
name: s1p1
type: FPPhysicalInterface
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/default/object/interfaceobjects/
self: https://vienna.cisco.com/api/fmc_config/v1/domain/default/object/interfacegroups/Interface-obj-UUID-3
metadata:
domain:
id: domainUUID
name: Global
type: domain
lastUser:
id: User-UUID
name: admin
type: user
readOnly:
state: true
timestamp: 1459973857.0
name: Test1
type: InterfaceGroup
links:
self: https://vienna.cisco.com/api/fmc_config/v1/domain/default/object/interfaceobjects?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/InterfaceObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/interfaceobjects/{objectId}:
get:
deprecated: false
description: '**Get the security zone or interface group associated with the specified ID.**'
operationId: getInterfaceObject
parameters:
- description: Unique identifier of the security zone or interface group.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InterfaceObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/internalcas:
get:
deprecated: false
description: '**Get the list of all internal certificate authorities.**'
operationId: getAllInternalCA
parameters:
- description: Filter by name of the certifcate authority.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/internalcas?limit=2 ( Get all internal CAs with limit set to 2 )':
value:
items:
- id: 89bf0f10-9c12-11ec-b407-2bbe55c5f4d0
name: csr_test1_modified_again
type: InternalCA
- id: f5b29ecc-9c11-11ec-b407-2bbe55c5f4d0
name: import_CA_1
type: InternalCA
links:
self: https://172.29.182.90:10215/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcas?offset=0&limit=2
paging:
count: 3
limit: 2
next:
- https://172.29.182.90:10215/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcas?offset=2&limit=1
offset: 0
pages: 2
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/internalcas?limit=2&expanded=true ( Get all internal
CAs with limit set to 2 and expanded set to true )'
: value:
items:
- cert: '-----BEGIN CERTIFICATE-----
MIIDpjCCAo6gAwIBAgIUI7aPW1n1yFkRVEmMLwToEGqwYHMwDQYJKoZIhvcNAQEL
BQAwczELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExETAPBgNVBAcM
CE1pbHBpdGFzMQ4wDAYDVQQKDAVDaXNjbzEMMAoGA1UECwwDU0JHMR4wHAYDVQQD
DBVpbnRlcm5hbENBLnNlbGZTaWduZWQwHhcNMjIwMzA0MjMyNDM4WhcNMzIwMzAx
MjMyNDM4WjBzMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTERMA8G
A1UEBwwITWlscGl0YXMxDjAMBgNVBAoMBUNpc2NvMQwwCgYDVQQLDANTQkcxHjAc
BgNVBAMMFWludGVybmFsQ0Euc2VsZlNpZ25lZDCCASIwDQYJKoZIhvcNAQEBBQAD
ggEPADCCAQoCggEBAMLWMS+NcfRf8Hh8pfVikYztUIczuTVx/nmMhl5tPJ2WgPoS
qgwf0LWY+6dO3DJHKr/Hk9q97J1EuJvO6bZ1CFBJ81hxb+bjcx+DxeoMTgPT4aV6
hBn9PF+yALUypcaxBUCFX2+a6XF4Stl/ms6iAHTdweNakk2j0AeRd2VLotNC+EXo
DBxmNFUhtCf18s3jep0qyDRFHlJs/EIHPBvBZZWcY9EoFep7rpLl+kTzov45ueLK
tKVhUHF2wGTvUCSkOFsiR7OJkDygxCMLa/lHamch+sPlVfi6QKKNrJ/oMpA7wb+u
tn/vPznembpM7/AyG/Hg8wyJ45NvYas6/6NapCsCAwEAAaMyMDAwHQYDVR0OBBYE
FG1SRpU4x4LG+2yDa6CsVdx+ZLirMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcN
AQELBQADggEBAEqJwLfghOaZOmzmn26pWeEiPnLsDlgidJTnhAlYhAFWXYMVBpDF
YYqpQ2WIJq1Vhx8JZLfC80GlDYeQwlgnORcc0SLX9b3ppuzZAZRx/Y4FFlreD+J2
r3DpohES1+v7RNHHu61I5OkisqaDvTQs1T4VPjI2ldIbdORONMsvOuKbI1rzZe3A
mr/VZhUKSiuf4VZPVGb60fVRc5oOXv4emOFoCtc+ZzoWH3p1OfgAmSkZJ2lxgbGd
FCf0bqI1h5EEg6uz9SXH/McXP4EaCqwInbGFXfeLtyjsi+H36UdrQCfeo00TXLiR
eXHiNiJd8Q2c4KFIKeG++lCxVAxqZ652iN4=
-----END CERTIFICATE-----
'
certFingerprint: B0:F2:7E:C3:70:26:0D:19:7C:ED:C4:5A:C2:7A:76:13:4D:62:BD:88
id: 426da3f6-9c12-11ec-b407-2bbe55c5f4d0
issuerCommonName: internalCA.selfSigned
issuerOrganization: Cisco
issuerOrganizationUnit: SBG
links:
self: https://172.29.182.90:10215/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcas/426da3f6-9c12-11ec-b407-2bbe55c5f4d0
name: self_signed_CA_2_modified
passPhrase: '********'
privateKey: '********'
publicKeyFingerprint: e0b59499234dc2ba4efabf43620378ce3e2b7da3
serialNumber: 23:b6:8f:5b:59:f5:c8:59:11:54:49:8c:2f:04:e8:10:6a:b0:60:73
subjectCommonName: internalCA.selfSigned
subjectCountry: US
subjectLocality: Milpitas
subjectOrganization: Cisco
subjectOrganizationUnit: SBG
subjectState: California
type: InternalCA
validityEndDate: '2032-03-01T23:24:38Z'
validityStartDate: '2022-03-04T23:24:38Z'
- cert: '-----BEGIN CERTIFICATE-----
MIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV
BAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE
ChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy
NDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3
MTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp
dHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs
MTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG
SIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg
x9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6
imwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt
8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC
sDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46
oYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0
dHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx
MDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT
FzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3
hGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko
42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu
rIuPFw==
-----END CERTIFICATE-----'
certFingerprint: 50:9D:77:44:D4:A3:AC:3B:E1:F6:11:2E:85:19:15:0B:D0:D4:6B:D3
id: f5b29ecc-9c11-11ec-b407-2bbe55c5f4d0
issuerCommonName: internal1024.internal1024
issuerOrganization: Sourcefire
issuerOrganizationUnit: Development
links:
self: https://172.29.182.90:10215/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcas/f5b29ecc-9c11-11ec-b407-2bbe55c5f4d0
name: import_CA_1
passPhrase: '********'
privateKey: '********'
publicKeyFingerprint: 820bad9cae9c1ef9eb2cfea20ebbfe3fe2eb4521
serialNumber: fa:a5:5d:ae:66:34:13:17
subjectCommonName: internal1024.internal1024
subjectCountry: US
subjectLocality: Pittsburgh
subjectOrganization: Sourcefire
subjectOrganizationUnit: Development
subjectState: PA
type: InternalCA
validityEndDate: '2025-03-07T15:45:51Z'
validityStartDate: '2015-03-10T15:45:51Z'
links:
self: https://172.29.182.90:10215/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcas?offset=0&limit=2&expanded=true
paging:
count: 3
limit: 2
next:
- https://172.29.182.90:10215/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcas?offset=2&limit=1&expanded=true
offset: 0
pages: 2
schema:
$ref: '#/components/schemas/InternalCAListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an internal certificate authority. _Check the response section for applicable examples (if any)._**'
operationId: createInternalCA
parameters:
- description: Boolean parameter to specify if the request is to create a Certificate Signing Request(CSR) or not. false
by default. When false, if a certificate/key pair is provided, the certificate/key pair is imported.
Else, a self-signed certificate is generated. When true, a CSR is generated.
in: query
name: isCSR
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/internalcas?isCSR=false ( Test internal CA import
with certificate and key )'
: value:
cert: '-----BEGIN CERTIFICATE-----
MIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV
BAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE
ChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy
NDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3
MTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp
dHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs
MTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG
SIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg
x9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6
imwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt
8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC
sDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46
oYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0
dHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx
MDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT
FzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3
hGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko
42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu
rIuPFw==
-----END CERTIFICATE-----'
name: import_CA_2
passPhrase: password
privateKey: REDACTED_PRIVATE_KEY_EXAMPLE
subjectCountry: US
type: InternalCA
? 'Example 2 : POST /fmc_config/v1/domain/domainUUID/object/internalcas?isCSR=false ( Test Generation of Self-signed
internal CA )'
: value:
name: self_signed_CA_1
subjectCommonName: internalCA.selfSigned
subjectCountry: US
subjectLocality: Milpitas
subjectOrganization: Cisco
subjectOrganizationUnit: SBG
subjectState: California
type: InternalCA
? 'Example 3 : POST /fmc_config/v1/domain/domainUUID/object/internalcas?isCSR=true ( Test Generation of Certificate
Signing Request(CSR) )'
: value:
name: csr_test1
subjectCommonName: internalCA.csr1
subjectCountry: US
subjectLocality: Milpitas
subjectOrganization: Cisco
subjectOrganizationUnit: SBG
subjectState: California
type: InternalCA
schema:
$ref: '#/components/schemas/InternalCA'
type: object
description: The input Internal CA model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/internalcas?isCSR=false ( Test internal CA import
with certificate and key )'
: value:
cert: '-----BEGIN CERTIFICATE-----
MIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV
BAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE
ChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy
NDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3
MTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp
dHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs
MTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG
SIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg
x9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6
imwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt
8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC
sDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46
oYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0
dHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx
MDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT
FzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3
hGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko
42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu
rIuPFw==
-----END CERTIFICATE-----'
certFingerprint: 50:9D:77:44:D4:A3:AC:3B:E1:F6:11:2E:85:19:15:0B:D0:D4:6B:D3
id: af52e3a2-9c15-11ec-b407-2bbe55c5f4d0
issuerCommonName: internal1024.internal1024
issuerOrganization: Sourcefire
issuerOrganizationUnit: Development
links:
self: https://172.29.182.90:10215/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcas/af52e3a2-9c15-11ec-b407-2bbe55c5f4d0
name: import_CA_2
passPhrase: '********'
privateKey: '********'
publicKeyFingerprint: 820bad9cae9c1ef9eb2cfea20ebbfe3fe2eb4521
serialNumber: fa:a5:5d:ae:66:34:13:17
subjectCommonName: internal1024.internal1024
subjectCountry: US
subjectLocality: Pittsburgh
subjectOrganization: Sourcefire
subjectOrganizationUnit: Development
subjectState: PA
type: InternalCA
validityEndDate: '2025-03-07T15:45:51Z'
validityStartDate: '2015-03-10T15:45:51Z'
? 'Example 2 : POST /fmc_config/v1/domain/domainUUID/object/internalcas?isCSR=false ( Test Generation of Self-signed
internal CA )'
: value:
cert: '-----BEGIN CERTIFICATE-----
MIIDpjCCAo6gAwIBAgIUQ5xDv1eGwRI27lx8dkQVB1wJCa8wDQYJKoZIhvcNAQEL
BQAwczELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExETAPBgNVBAcM
CE1pbHBpdGFzMQ4wDAYDVQQKDAVDaXNjbzEMMAoGA1UECwwDU0JHMR4wHAYDVQQD
DBVpbnRlcm5hbENBLnNlbGZTaWduZWQwHhcNMjIwMzA0MjM1MDMxWhcNMzIwMzAx
MjM1MDMxWjBzMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTERMA8G
A1UEBwwITWlscGl0YXMxDjAMBgNVBAoMBUNpc2NvMQwwCgYDVQQLDANTQkcxHjAc
BgNVBAMMFWludGVybmFsQ0Euc2VsZlNpZ25lZDCCASIwDQYJKoZIhvcNAQEBBQAD
ggEPADCCAQoCggEBANEr1FXiWdOpOUrsc7huXZdxrRGnl36g4pl2sYVYIFzhp4pw
qTOjpL830W6ft6GBjQepJG8Luld5NymfI3EtNLc21WxoREzI9FwM8m8I5CHplCBe
5RvgBRQ66cWG+kzhBKqsIdVJGoWboGR2v7EpZmAYvVm8yGrLUHSJ3+N5EfLO6Dz5
2QKAWmSspm48bvGs/xZGRj7evGPe25RsCK610WPy9LFywn/hql54dYI1dsB20of6
h1bvJ2r1tRsQnFORoZ/sRASnM6Zqv7MPlBXA36Fg5myq1/r0viDKNcH/IHpAzCME
/RH8WF5WgRexY1fiJ+cKK9ngyiydtiyDuSkpLlcCAwEAAaMyMDAwHQYDVR0OBBYE
FOpg7b1NGJppLbEEvXcPXTjbrflHMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcN
AQELBQADggEBAMKTAlau96MSt7qCGv8MK5qpv3q6ho9Be0bKVeC/JM0dvfj92XS/
rvqu2hPV58hcH/rGS5JL+bExlVb1JM0vR2E+iClTSHsgnnfVCAhYLlcFP9qMaW0J
k9Kh68gIAb2AgW0TbQ1gCqSl8dhL7fgwXR1gM5ymJTqLxux+vsacJ4qFsNQnT+Pk
hfl9jX/r8+DInPfl34cdXwTKbJclFV0raiyqVLi58aGXE0Z8N6byxLra4lhtptwW
jQfFiJXJoOHpz5kMv0IZmH4ueTe0fiovlyA5ntPeav3VG4bNSOStmpTBSmK3yacP
Bv/u/8HZ5iAPsHd0W3g1QlvgpZmcgGBi2eg=
-----END CERTIFICATE-----
'
certFingerprint: 04:62:28:65:8C:A1:6C:DF:99:84:82:89:BD:B9:3C:E9:6C:33:15:DD
id: e0369d2e-9c15-11ec-843a-29be55c5f4d0
issuerCommonName: internalCA.selfSigned
issuerOrganization: Cisco
issuerOrganizationUnit: SBG
links:
self: https://172.29.182.90:10215/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcas/e0369d2e-9c15-11ec-843a-29be55c5f4d0
name: self_signed_CA_1
passPhrase: '********'
privateKey: '********'
publicKeyFingerprint: 8be7c82d988f85afef8538c717acc7cad8f6b6f8
serialNumber: 43:9c:43:bf:57:86:c1:12:36:ee:5c:7c:76:44:15:07:5c:09:09:af
subjectCommonName: internalCA.selfSigned
subjectCountry: US
subjectLocality: Milpitas
subjectOrganization: Cisco
subjectOrganizationUnit: SBG
subjectState: California
type: InternalCA
validityEndDate: '2032-03-01T23:50:31Z'
validityStartDate: '2022-03-04T23:50:31Z'
? 'Example 3 : POST /fmc_config/v1/domain/domainUUID/object/internalcas?isCSR=true ( Test Generation of Certificate
Signing Request(CSR) )'
: value:
csr: '-----BEGIN CERTIFICATE REQUEST-----
MIIC8zCCAdsCAQAwbTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWEx
ETAPBgNVBAcMCE1pbHBpdGFzMQ4wDAYDVQQKDAVDaXNjbzEMMAoGA1UECwwDU0JH
MRgwFgYDVQQDDA9pbnRlcm5hbENBLmNzcjEwggEiMA0GCSqGSIb3DQEBAQUAA4IB
DwAwggEKAoIBAQDyojEdqK+QkoIP4oofbX0MGucQoedg6TB/O1zCQ6gs9CAn1GXg
WgGhhWOS6z1k8C48x4r8PsGbw+oaa9xp0fsNyMDpb7/aCuze3U/KuKE2Ue4hAh50
CFDEVdslKlpQlqhIpUvYWAt6/kbsfLadkjWR9K8DFQU1QvjoK3Naaq8n4fWVEv9n
9qsLwl005xs4T8sCGtHpzjLRZfFGeU+xhpJxEQdMB+HtbXdCtDv3KbFrrV/JidTA
jeBcWpEZ033PiN1vMuGljlAOzJJ7nHK2toG6aWKYVw7SfFWWQp4OrsrLlfX4s8v+
9Qpwgw//U3lmfE3aa8iyGlbRrmtImtlKtDSZAgMBAAGgQTA/BgkqhkiG9w0BCQ4x
MjAwMB0GA1UdDgQWBBQszvHbRYLW2zqmdMm40QaGCKdDeDAPBgNVHRMBAf8EBTAD
AQH/MA0GCSqGSIb3DQEBCwUAA4IBAQC64wIpVN8coS3jIZ2mGuj54UCNoKRD54lb
8nHq8ZpxcjfoJH3Kq7e2PUdwjS14/eXhqRJDGTWSlicGqzaKRLjkKZG+3FZJ8Ov0
TVAnTKRGYiD608vGLP+AyHQRGKXLDf/TqFUknjW/r9MuEshbTpSXn/4tSUVZOr8o
gv6V+oyikbX7F0mMTHcGYybuXw+yIcSd4c6wKZzkN1Uozi27JVUZ2isHTl/D8xwG
butegvk5/qyG/OjDLkWmxtjbqC9zKvgJjUx2o2jgoFi+XGRWZUdHA8kztjEGEk3S
+COz+hzCNpXnt7XqpkwOaRR2gctw/39WkhiwNNJZDRylHdTMhcJU
-----END CERTIFICATE REQUEST-----
'
id: 31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
links:
self: https://172.29.182.90:10215/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcas/31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
name: csr_test1
passPhrase: '********'
privateKey: '********'
subjectCommonName: internalCA.csr1
subjectCountry: US
subjectLocality: Milpitas
subjectOrganization: Cisco
subjectOrganizationUnit: SBG
subjectState: California
type: InternalCA
schema:
$ref: '#/components/schemas/InternalCA'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/internalcas/{objectId}:
delete:
deprecated: false
description: '**Delete the internal certificate authority associated with the specified ID. _Check the response section
for applicable examples (if any)._**'
operationId: deleteInternalCA
parameters:
- description: Unique identifier of the internal certificate authority.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/object/internalcas/31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
( Test DELETE of Internal CA )'
: value:
cert: '-----BEGIN CERTIFICATE-----
MIIC3jCCAkcCAQEwDQYJKoZIhvcNAQEFBQAwfjELMAkGA1UEBhMCVVMxCzAJBgNV
BAgTAlBBMRMwEQYDVQQHEwpQaXR0c2J1cmdoMRMwEQYDVQQKEwpTb3VyY2VmaXJl
MSIwIAYDVQQDExlpbnRlcm5hbDEwMjQuaW50ZXJuYWwxMDI0MRQwEgYDVQQLEwtE
ZXZlbG9wbWVudDAeFw0yMjAzMDUwMDM0NThaFw0yMzAzMDUwMDM0NThaMG0xCzAJ
BgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhNaWxwaXRh
czEOMAwGA1UECgwFQ2lzY28xDDAKBgNVBAsMA1NCRzEYMBYGA1UEAwwPaW50ZXJu
YWxDQS5jc3IxMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8qIxHaiv
kJKCD+KKH219DBrnEKHnYOkwfztcwkOoLPQgJ9Rl4FoBoYVjkus9ZPAuPMeK/D7B
m8PqGmvcadH7DcjA6W+/2grs3t1PyrihNlHuIQIedAhQxFXbJSpaUJaoSKVL2FgL
ev5G7Hy2nZI1kfSvAxUFNUL46CtzWmqvJ+H1lRL/Z/arC8JdNOcbOE/LAhrR6c4y
0WXxRnlPsYaScREHTAfh7W13QrQ79ymxa61fyYnUwI3gXFqRGdN9z4jdbzLhpY5Q
DsySe5xytraBumlimFcO0nxVlkKeDq7Ky5X1+LPL/vUKcIMP/1N5ZnxN2mvIshpW
0a5rSJrZSrQ0mQIDAQABMA0GCSqGSIb3DQEBBQUAA4GBAAHUXBwgJ7xtMisgdSUR
VzDRyc5JdR5VkWOxmxTQ5Wbqbs/p+1xRo1PxPu6cQAyCsyfzlVdU1uLHSxvUyW3k
DR9Y5vQau5085hznD8ROvMFYPHCFq68L0d1dWuvQt1Mvy04OYbIvR/C6539+n393
OULqbcG8DIPBdeRt+IkEOIM/
-----END CERTIFICATE-----'
certFingerprint: 81:BB:00:0E:F4:13:CF:99:93:18:1B:35:0D:40:0A:D0:DE:16:92:3D
csr: '-----BEGIN CERTIFICATE REQUEST-----
MIIC8zCCAdsCAQAwbTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWEx
ETAPBgNVBAcMCE1pbHBpdGFzMQ4wDAYDVQQKDAVDaXNjbzEMMAoGA1UECwwDU0JH
MRgwFgYDVQQDDA9pbnRlcm5hbENBLmNzcjEwggEiMA0GCSqGSIb3DQEBAQUAA4IB
DwAwggEKAoIBAQDyojEdqK+QkoIP4oofbX0MGucQoedg6TB/O1zCQ6gs9CAn1GXg
WgGhhWOS6z1k8C48x4r8PsGbw+oaa9xp0fsNyMDpb7/aCuze3U/KuKE2Ue4hAh50
CFDEVdslKlpQlqhIpUvYWAt6/kbsfLadkjWR9K8DFQU1QvjoK3Naaq8n4fWVEv9n
9qsLwl005xs4T8sCGtHpzjLRZfFGeU+xhpJxEQdMB+HtbXdCtDv3KbFrrV/JidTA
jeBcWpEZ033PiN1vMuGljlAOzJJ7nHK2toG6aWKYVw7SfFWWQp4OrsrLlfX4s8v+
9Qpwgw//U3lmfE3aa8iyGlbRrmtImtlKtDSZAgMBAAGgQTA/BgkqhkiG9w0BCQ4x
MjAwMB0GA1UdDgQWBBQszvHbRYLW2zqmdMm40QaGCKdDeDAPBgNVHRMBAf8EBTAD
AQH/MA0GCSqGSIb3DQEBCwUAA4IBAQC64wIpVN8coS3jIZ2mGuj54UCNoKRD54lb
8nHq8ZpxcjfoJH3Kq7e2PUdwjS14/eXhqRJDGTWSlicGqzaKRLjkKZG+3FZJ8Ov0
TVAnTKRGYiD608vGLP+AyHQRGKXLDf/TqFUknjW/r9MuEshbTpSXn/4tSUVZOr8o
gv6V+oyikbX7F0mMTHcGYybuXw+yIcSd4c6wKZzkN1Uozi27JVUZ2isHTl/D8xwG
butegvk5/qyG/OjDLkWmxtjbqC9zKvgJjUx2o2jgoFi+XGRWZUdHA8kztjEGEk3S
+COz+hzCNpXnt7XqpkwOaRR2gctw/39WkhiwNNJZDRylHdTMhcJU
-----END CERTIFICATE REQUEST-----
'
id: 31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
issuerCommonName: internal1024.internal1024
issuerOrganization: Sourcefire
issuerOrganizationUnit: Development
links:
self: https://172.29.182.90:10215/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcas/31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
name: csr_test1_modified
passPhrase: '********'
privateKey: '********'
publicKeyFingerprint: 57b408be93416833c5972b67850152ad3e47ce7b
serialNumber: 1 (0x1)
subjectCommonName: internalCA.csr1
subjectCountry: US
subjectLocality: Milpitas
subjectOrganization: Cisco
subjectOrganizationUnit: SBG
subjectState: California
type: InternalCA
validityEndDate: '2023-03-05T00:34:58Z'
validityStartDate: '2022-03-05T00:34:58Z'
schema:
$ref: '#/components/schemas/InternalCA'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the internal certificate authority associated with the specified ID.**'
operationId: getInternalCA
parameters:
- description: Unique identifier of the internal certificate authority.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/internalcas/89bf0f10-9c12-11ec-b407-2bbe55c5f4d0
( Get InternalCA by id )'
: value:
cert: '-----BEGIN CERTIFICATE-----
MIIC3jCCAkcCAQEwDQYJKoZIhvcNAQEFBQAwfjELMAkGA1UEBhMCVVMxCzAJBgNV
BAgTAlBBMRMwEQYDVQQHEwpQaXR0c2J1cmdoMRMwEQYDVQQKEwpTb3VyY2VmaXJl
MSIwIAYDVQQDExlpbnRlcm5hbDEwMjQuaW50ZXJuYWwxMDI0MRQwEgYDVQQLEwtE
ZXZlbG9wbWVudDAeFw0yMjAzMDQyMzI4MzNaFw0yMzAzMDQyMzI4MzNaMG0xCzAJ
BgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhNaWxwaXRh
czEOMAwGA1UECgwFQ2lzY28xDDAKBgNVBAsMA1NCRzEYMBYGA1UEAwwPaW50ZXJu
YWxDQS5jc3IxMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAv+qMl5Qx
l3/oFq5R++9zQ9Rhj2qBgxdcTH9QPL+2e6UJcCXRENgJEsuhktUcgvA+xu+6oxO/
UIhtMymCgQpap2DnJ8ioqewfNvPXi83Lljd8ie2/rp/D0a6kC8NPiAQdyJPYtma7
6M6Fnrt0fSZMhqNTV0QTTVkh5xQKvpM5glH3LuvPbF4sIdO/ufzp3O5KjHDpMmrP
sFbYvnwxO+M+rp5I5SUq37R153wjH1zyqEqFYCkBI/t5Bbte+LHSLvPmkd3ezbSh
1V3MbfXIFb4G5o11kd8wHsZVvxUNGOIJDy5TblmVliteTpN5kQvclX7bArS5sVht
A5GDrPF3eht8cwIDAQABMA0GCSqGSIb3DQEBBQUAA4GBAHDVIUjmVPKhsLFouuAv
TNYBCMOpgAoPtYIdFqQqacD6U6Sd6ZUxGQtQjhse46hR/BL6rza3d4CrfyrJ5wOf
fywp52wr9bOXvAOg2Swak0Yrxl3zT2kmlSU6L/FGPS+PpIPUwD0AawdqxZVbxdeh
QuxGuU1bpUIdznOp0do9NUuQ
-----END CERTIFICATE-----'
certFingerprint: 1D:9B:A6:DE:B2:58:D5:28:9F:E0:31:F6:E2:C2:33:97:65:C3:60:EF
csr: '-----BEGIN CERTIFICATE REQUEST-----
MIIC8zCCAdsCAQAwbTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWEx
ETAPBgNVBAcMCE1pbHBpdGFzMQ4wDAYDVQQKDAVDaXNjbzEMMAoGA1UECwwDU0JH
MRgwFgYDVQQDDA9pbnRlcm5hbENBLmNzcjEwggEiMA0GCSqGSIb3DQEBAQUAA4IB
DwAwggEKAoIBAQC/6oyXlDGXf+gWrlH773ND1GGPaoGDF1xMf1A8v7Z7pQlwJdEQ
2AkSy6GS1RyC8D7G77qjE79QiG0zKYKBClqnYOcnyKip7B8289eLzcuWN3yJ7b+u
n8PRrqQLw0+IBB3Ik9i2ZrvozoWeu3R9JkyGo1NXRBNNWSHnFAq+kzmCUfcu689s
Xiwh07+5/Onc7kqMcOkyas+wVti+fDE74z6unkjlJSrftHXnfCMfXPKoSoVgKQEj
+3kFu174sdIu8+aR3d7NtKHVXcxt9cgVvgbmjXWR3zAexlW/FQ0Y4gkPLlNuWZWW
K15Ok3mRC9yVftsCtLmxWG0DkYOs8Xd6G3xzAgMBAAGgQTA/BgkqhkiG9w0BCQ4x
MjAwMB0GA1UdDgQWBBRbXxp4YbrPDXC3iGNLu195W1Q8fjAPBgNVHRMBAf8EBTAD
AQH/MA0GCSqGSIb3DQEBCwUAA4IBAQA3emjNZNLo6xJIiTX1wr5W2p8OPcErgHaj
faiRNnHIbO1jm78gyl3bSPZmCPDypSMxOf5LbIF7T5doSMyaXMFEIKPFOFsKLxNG
A1X+bz/2dum+9tIa/pdp5KbHMRuNE+cQVSR0pOMg2ZRUMZ0MxUsyQBv5Y57ydpd+
r2RiQGO6AIuJ7wLgldrxxTxBp4IBA90VP4gP1dvVQfxJWxd12a7pM4brBjSQh4Zg
U+xBEthgkK5Cog8IBaElYoKZfUqs1mJf4l6S3v/I4zn+pXyPk7NEGVyb5IwEAql/
eIbBiy/YQ2BUumAESZbynNCdM9fXtxm5pxRMQ3eeloTRSjP6WOu4
-----END CERTIFICATE REQUEST-----
'
id: 89bf0f10-9c12-11ec-b407-2bbe55c5f4d0
issuerCommonName: internal1024.internal1024
issuerOrganization: Sourcefire
issuerOrganizationUnit: Development
links:
self: https://172.29.182.90:10215/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcas/89bf0f10-9c12-11ec-b407-2bbe55c5f4d0
name: csr_test1_modified_again
passPhrase: '********'
privateKey: '********'
publicKeyFingerprint: dc66f0b774901337adcda2cd9a94fa45eac463d2
serialNumber: 1 (0x1)
subjectCommonName: internalCA.csr1
subjectCountry: US
subjectLocality: Milpitas
subjectOrganization: Cisco
subjectOrganizationUnit: SBG
subjectState: California
type: InternalCA
validityEndDate: '2023-03-04T23:28:33Z'
validityStartDate: '2022-03-04T23:28:33Z'
schema:
$ref: '#/components/schemas/InternalCA'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the internal certificate authority associated with the specified ID. _Check the response section
for applicable examples (if any)._**'
operationId: updateInternalCA
parameters:
- description: Unique identifier of the internal certificate authority.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/internalcas/31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
( Test Install of Certificate Signed using CSR )'
: value:
cert: '-----BEGIN CERTIFICATE-----
MIIC3jCCAkcCAQEwDQYJKoZIhvcNAQEFBQAwfjELMAkGA1UEBhMCVVMxCzAJBgNV
BAgTAlBBMRMwEQYDVQQHEwpQaXR0c2J1cmdoMRMwEQYDVQQKEwpTb3VyY2VmaXJl
MSIwIAYDVQQDExlpbnRlcm5hbDEwMjQuaW50ZXJuYWwxMDI0MRQwEgYDVQQLEwtE
ZXZlbG9wbWVudDAeFw0yMjAzMDUwMDM0NThaFw0yMzAzMDUwMDM0NThaMG0xCzAJ
BgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhNaWxwaXRh
czEOMAwGA1UECgwFQ2lzY28xDDAKBgNVBAsMA1NCRzEYMBYGA1UEAwwPaW50ZXJu
YWxDQS5jc3IxMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8qIxHaiv
kJKCD+KKH219DBrnEKHnYOkwfztcwkOoLPQgJ9Rl4FoBoYVjkus9ZPAuPMeK/D7B
m8PqGmvcadH7DcjA6W+/2grs3t1PyrihNlHuIQIedAhQxFXbJSpaUJaoSKVL2FgL
ev5G7Hy2nZI1kfSvAxUFNUL46CtzWmqvJ+H1lRL/Z/arC8JdNOcbOE/LAhrR6c4y
0WXxRnlPsYaScREHTAfh7W13QrQ79ymxa61fyYnUwI3gXFqRGdN9z4jdbzLhpY5Q
DsySe5xytraBumlimFcO0nxVlkKeDq7Ky5X1+LPL/vUKcIMP/1N5ZnxN2mvIshpW
0a5rSJrZSrQ0mQIDAQABMA0GCSqGSIb3DQEBBQUAA4GBAAHUXBwgJ7xtMisgdSUR
VzDRyc5JdR5VkWOxmxTQ5Wbqbs/p+1xRo1PxPu6cQAyCsyfzlVdU1uLHSxvUyW3k
DR9Y5vQau5085hznD8ROvMFYPHCFq68L0d1dWuvQt1Mvy04OYbIvR/C6539+n393
OULqbcG8DIPBdeRt+IkEOIM/
-----END CERTIFICATE-----'
id: 31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
name: csr_test1
type: InternalCA
? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/object/internalcas/31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
( Test PUT of Internal CA to update name )'
: value:
id: 31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
name: csr_test1_modified
type: InternalCA
schema:
$ref: '#/components/schemas/InternalCA'
type: object
description: The input Internal CA model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/internalcas/31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
( Test Install of Certificate Signed using CSR )'
: value:
cert: '-----BEGIN CERTIFICATE-----
MIIC3jCCAkcCAQEwDQYJKoZIhvcNAQEFBQAwfjELMAkGA1UEBhMCVVMxCzAJBgNV
BAgTAlBBMRMwEQYDVQQHEwpQaXR0c2J1cmdoMRMwEQYDVQQKEwpTb3VyY2VmaXJl
MSIwIAYDVQQDExlpbnRlcm5hbDEwMjQuaW50ZXJuYWwxMDI0MRQwEgYDVQQLEwtE
ZXZlbG9wbWVudDAeFw0yMjAzMDUwMDM0NThaFw0yMzAzMDUwMDM0NThaMG0xCzAJ
BgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhNaWxwaXRh
czEOMAwGA1UECgwFQ2lzY28xDDAKBgNVBAsMA1NCRzEYMBYGA1UEAwwPaW50ZXJu
YWxDQS5jc3IxMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8qIxHaiv
kJKCD+KKH219DBrnEKHnYOkwfztcwkOoLPQgJ9Rl4FoBoYVjkus9ZPAuPMeK/D7B
m8PqGmvcadH7DcjA6W+/2grs3t1PyrihNlHuIQIedAhQxFXbJSpaUJaoSKVL2FgL
ev5G7Hy2nZI1kfSvAxUFNUL46CtzWmqvJ+H1lRL/Z/arC8JdNOcbOE/LAhrR6c4y
0WXxRnlPsYaScREHTAfh7W13QrQ79ymxa61fyYnUwI3gXFqRGdN9z4jdbzLhpY5Q
DsySe5xytraBumlimFcO0nxVlkKeDq7Ky5X1+LPL/vUKcIMP/1N5ZnxN2mvIshpW
0a5rSJrZSrQ0mQIDAQABMA0GCSqGSIb3DQEBBQUAA4GBAAHUXBwgJ7xtMisgdSUR
VzDRyc5JdR5VkWOxmxTQ5Wbqbs/p+1xRo1PxPu6cQAyCsyfzlVdU1uLHSxvUyW3k
DR9Y5vQau5085hznD8ROvMFYPHCFq68L0d1dWuvQt1Mvy04OYbIvR/C6539+n393
OULqbcG8DIPBdeRt+IkEOIM/
-----END CERTIFICATE-----'
certFingerprint: 81:BB:00:0E:F4:13:CF:99:93:18:1B:35:0D:40:0A:D0:DE:16:92:3D
csr: '-----BEGIN CERTIFICATE REQUEST-----
MIIC8zCCAdsCAQAwbTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWEx
ETAPBgNVBAcMCE1pbHBpdGFzMQ4wDAYDVQQKDAVDaXNjbzEMMAoGA1UECwwDU0JH
MRgwFgYDVQQDDA9pbnRlcm5hbENBLmNzcjEwggEiMA0GCSqGSIb3DQEBAQUAA4IB
DwAwggEKAoIBAQDyojEdqK+QkoIP4oofbX0MGucQoedg6TB/O1zCQ6gs9CAn1GXg
WgGhhWOS6z1k8C48x4r8PsGbw+oaa9xp0fsNyMDpb7/aCuze3U/KuKE2Ue4hAh50
CFDEVdslKlpQlqhIpUvYWAt6/kbsfLadkjWR9K8DFQU1QvjoK3Naaq8n4fWVEv9n
9qsLwl005xs4T8sCGtHpzjLRZfFGeU+xhpJxEQdMB+HtbXdCtDv3KbFrrV/JidTA
jeBcWpEZ033PiN1vMuGljlAOzJJ7nHK2toG6aWKYVw7SfFWWQp4OrsrLlfX4s8v+
9Qpwgw//U3lmfE3aa8iyGlbRrmtImtlKtDSZAgMBAAGgQTA/BgkqhkiG9w0BCQ4x
MjAwMB0GA1UdDgQWBBQszvHbRYLW2zqmdMm40QaGCKdDeDAPBgNVHRMBAf8EBTAD
AQH/MA0GCSqGSIb3DQEBCwUAA4IBAQC64wIpVN8coS3jIZ2mGuj54UCNoKRD54lb
8nHq8ZpxcjfoJH3Kq7e2PUdwjS14/eXhqRJDGTWSlicGqzaKRLjkKZG+3FZJ8Ov0
TVAnTKRGYiD608vGLP+AyHQRGKXLDf/TqFUknjW/r9MuEshbTpSXn/4tSUVZOr8o
gv6V+oyikbX7F0mMTHcGYybuXw+yIcSd4c6wKZzkN1Uozi27JVUZ2isHTl/D8xwG
butegvk5/qyG/OjDLkWmxtjbqC9zKvgJjUx2o2jgoFi+XGRWZUdHA8kztjEGEk3S
+COz+hzCNpXnt7XqpkwOaRR2gctw/39WkhiwNNJZDRylHdTMhcJU
-----END CERTIFICATE REQUEST-----
'
id: 31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
issuerCommonName: internal1024.internal1024
issuerOrganization: Sourcefire
issuerOrganizationUnit: Development
links:
self: https://172.29.182.90:10215/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcas/31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
name: csr_test1
passPhrase: '********'
privateKey: '********'
publicKeyFingerprint: 57b408be93416833c5972b67850152ad3e47ce7b
serialNumber: 1 (0x1)
subjectCommonName: internalCA.csr1
subjectCountry: US
subjectLocality: Milpitas
subjectOrganization: Cisco
subjectOrganizationUnit: SBG
subjectState: California
type: InternalCA
validityEndDate: '2023-03-05T00:34:58Z'
validityStartDate: '2022-03-05T00:34:58Z'
? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/object/internalcas/31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
( Test PUT of Internal CA to update name )'
: value:
cert: '-----BEGIN CERTIFICATE-----
MIIC3jCCAkcCAQEwDQYJKoZIhvcNAQEFBQAwfjELMAkGA1UEBhMCVVMxCzAJBgNV
BAgTAlBBMRMwEQYDVQQHEwpQaXR0c2J1cmdoMRMwEQYDVQQKEwpTb3VyY2VmaXJl
MSIwIAYDVQQDExlpbnRlcm5hbDEwMjQuaW50ZXJuYWwxMDI0MRQwEgYDVQQLEwtE
ZXZlbG9wbWVudDAeFw0yMjAzMDUwMDM0NThaFw0yMzAzMDUwMDM0NThaMG0xCzAJ
BgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhNaWxwaXRh
czEOMAwGA1UECgwFQ2lzY28xDDAKBgNVBAsMA1NCRzEYMBYGA1UEAwwPaW50ZXJu
YWxDQS5jc3IxMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8qIxHaiv
kJKCD+KKH219DBrnEKHnYOkwfztcwkOoLPQgJ9Rl4FoBoYVjkus9ZPAuPMeK/D7B
m8PqGmvcadH7DcjA6W+/2grs3t1PyrihNlHuIQIedAhQxFXbJSpaUJaoSKVL2FgL
ev5G7Hy2nZI1kfSvAxUFNUL46CtzWmqvJ+H1lRL/Z/arC8JdNOcbOE/LAhrR6c4y
0WXxRnlPsYaScREHTAfh7W13QrQ79ymxa61fyYnUwI3gXFqRGdN9z4jdbzLhpY5Q
DsySe5xytraBumlimFcO0nxVlkKeDq7Ky5X1+LPL/vUKcIMP/1N5ZnxN2mvIshpW
0a5rSJrZSrQ0mQIDAQABMA0GCSqGSIb3DQEBBQUAA4GBAAHUXBwgJ7xtMisgdSUR
VzDRyc5JdR5VkWOxmxTQ5Wbqbs/p+1xRo1PxPu6cQAyCsyfzlVdU1uLHSxvUyW3k
DR9Y5vQau5085hznD8ROvMFYPHCFq68L0d1dWuvQt1Mvy04OYbIvR/C6539+n393
OULqbcG8DIPBdeRt+IkEOIM/
-----END CERTIFICATE-----'
certFingerprint: 81:BB:00:0E:F4:13:CF:99:93:18:1B:35:0D:40:0A:D0:DE:16:92:3D
csr: '-----BEGIN CERTIFICATE REQUEST-----
MIIC8zCCAdsCAQAwbTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWEx
ETAPBgNVBAcMCE1pbHBpdGFzMQ4wDAYDVQQKDAVDaXNjbzEMMAoGA1UECwwDU0JH
MRgwFgYDVQQDDA9pbnRlcm5hbENBLmNzcjEwggEiMA0GCSqGSIb3DQEBAQUAA4IB
DwAwggEKAoIBAQDyojEdqK+QkoIP4oofbX0MGucQoedg6TB/O1zCQ6gs9CAn1GXg
WgGhhWOS6z1k8C48x4r8PsGbw+oaa9xp0fsNyMDpb7/aCuze3U/KuKE2Ue4hAh50
CFDEVdslKlpQlqhIpUvYWAt6/kbsfLadkjWR9K8DFQU1QvjoK3Naaq8n4fWVEv9n
9qsLwl005xs4T8sCGtHpzjLRZfFGeU+xhpJxEQdMB+HtbXdCtDv3KbFrrV/JidTA
jeBcWpEZ033PiN1vMuGljlAOzJJ7nHK2toG6aWKYVw7SfFWWQp4OrsrLlfX4s8v+
9Qpwgw//U3lmfE3aa8iyGlbRrmtImtlKtDSZAgMBAAGgQTA/BgkqhkiG9w0BCQ4x
MjAwMB0GA1UdDgQWBBQszvHbRYLW2zqmdMm40QaGCKdDeDAPBgNVHRMBAf8EBTAD
AQH/MA0GCSqGSIb3DQEBCwUAA4IBAQC64wIpVN8coS3jIZ2mGuj54UCNoKRD54lb
8nHq8ZpxcjfoJH3Kq7e2PUdwjS14/eXhqRJDGTWSlicGqzaKRLjkKZG+3FZJ8Ov0
TVAnTKRGYiD608vGLP+AyHQRGKXLDf/TqFUknjW/r9MuEshbTpSXn/4tSUVZOr8o
gv6V+oyikbX7F0mMTHcGYybuXw+yIcSd4c6wKZzkN1Uozi27JVUZ2isHTl/D8xwG
butegvk5/qyG/OjDLkWmxtjbqC9zKvgJjUx2o2jgoFi+XGRWZUdHA8kztjEGEk3S
+COz+hzCNpXnt7XqpkwOaRR2gctw/39WkhiwNNJZDRylHdTMhcJU
-----END CERTIFICATE REQUEST-----
'
id: 31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
issuerCommonName: internal1024.internal1024
issuerOrganization: Sourcefire
issuerOrganizationUnit: Development
links:
self: https://172.29.182.90:10215/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcas/31cba922-9c1b-11ec-bbc8-d3a155c5f4d0
name: csr_test1_modified
passPhrase: '********'
privateKey: '********'
publicKeyFingerprint: 57b408be93416833c5972b67850152ad3e47ce7b
serialNumber: 1 (0x1)
subjectCommonName: internalCA.csr1
subjectCountry: US
subjectLocality: Milpitas
subjectOrganization: Cisco
subjectOrganizationUnit: SBG
subjectState: California
type: InternalCA
validityEndDate: '2023-03-05T00:34:58Z'
validityStartDate: '2022-03-05T00:34:58Z'
schema:
$ref: '#/components/schemas/InternalCA'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/internalcertgroups:
get:
deprecated: false
description: '**Get the list of all internal certificate groups.**'
operationId: getInternalCertificateGroup
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/internalcertgroups?limit=2 ( Get all internal certificate
groups with limit set to 2 )'
: value:
items:
- id: e2105584-0477-11ed-9a97-a101fab9e81a
name: group1
type: InternalCertificateGroup
links:
self: https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcertgroups?offset=0&limit=25&expanded=true
paging:
count: 1
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/InternalCertificateGroupListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/internalcertificates:
get:
deprecated: false
description: '**Get the list of all internal certificates.**'
operationId: getAllInternalCertificate
parameters:
- description: Filter by name of certificate is supported.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/internalcertificates?limit=2 ( Get all internal
certificates with limit set to 2 )'
: value:
items:
- id: a5f1cc22-8ec0-11ec-a32b-b00fc429709e
name: test_post_cert1
type: InternalCertificate
- id: deba3c2c-83c8-11ec-b695-efd9b669047e
name: internal_cert_1
type: InternalCertificate
links:
self: https://172.29.182.90:10209/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcertificates?offset=0&limit=2
paging:
count: 3
limit: 2
next:
- https://172.29.182.90:10209/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcertificates?offset=2&limit=1
offset: 0
pages: 2
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/internalcertificates?limit=2&expanded=true ( Get
all internal certificates with limit set to 2 and expanded set to true )'
: value:
items:
- cert: '-----BEGIN CERTIFICATE-----
MIICVjCCAb8CAg37MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG
A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE
MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl
YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw
ODIyMDUyNzIzWhcNMTcwODIxMDUyNzIzWjBKMQswCQYDVQQGEwJKUDEOMAwGA1UE
CAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA93d3cuZXhhbXBs
ZS5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMYBBrx5PlP0WNI/ZdzD
+6Pktmurn+F2kQYbtc7XQh8/LTBvCo+P6iZoLEmUA9e7EXLRxgU1CVqeAi7QcAn9
MwBlc8ksFJHB0rtf9pmf8Oza9E0Bynlq/4/Kb1x+d+AyhL7oK9tQwB24uHOueHi1
C/iVv8CSWKiYe6hzN1txYe8rAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAASPdjigJ
kXCqKWpnZ/Oc75EUcMi6HztaW8abUMlYXPIgkV2F7YanHOB7K4f7OOLjiz8DTPFf
jC9UeuErhaA/zzWi8ewMTFZW/WshOrm3fNvcMrMLKtH534JKvcdMg6qIdjTFINIr
evnAhf0cwULaebn+lMs8Pdl7y37+sfluVok=
-----END CERTIFICATE-----
'
certFingerprint: E1:B2:B8:E5:EC:19:D3:45:A4:F9:AF:EC:86:94:F0:D9:C0:AA:25:CF
id: a5f1cc22-8ec0-11ec-a32b-b00fc429709e
issuerCommonName: Frank4DD Web CA
issuerOrganization: Frank4DD
issuerOrganizationUnit: WebCert Support
links:
self: https://172.29.182.90:10209/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcertificates/a5f1cc22-8ec0-11ec-a32b-b00fc429709e
name: test_post_cert1
passPhrase: '********'
privateKey: '********'
publicKeyFingerprint: 0628b7e8560921d4ec2ebfe8373678dda23674f5
serialNumber: 3579 (0xdfb)
subjectCommonName: www.example.com
subjectCountry: JP
subjectOrganization: Frank4DD
subjectState: Tokyo
type: InternalCertificate
validityEndDate: '2017-08-21T05:27:23Z'
validityStartDate: '2012-08-22T05:27:23Z'
version: 9adffb68-8ec2-11ec-b7b4-8cec1ff842b5
- cert: '-----BEGIN CERTIFICATE-----
MIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV
BAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE
ChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy
NDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3
MTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp
dHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs
MTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG
SIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg
x9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6
imwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt
8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC
sDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46
oYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0
dHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx
MDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT
FzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3
hGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko
42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu
rIuPFw==
-----END CERTIFICATE-----
'
certFingerprint: 50:9D:77:44:D4:A3:AC:3B:E1:F6:11:2E:85:19:15:0B:D0:D4:6B:D3
id: deba3c2c-83c8-11ec-b695-efd9b669047e
issuerCommonName: internal1024.internal1024
issuerOrganization: Sourcefire
issuerOrganizationUnit: Development
links:
self: https://172.29.182.90:10209/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcertificates/deba3c2c-83c8-11ec-b695-efd9b669047e
name: internal_cert_1
passPhrase: '********'
privateKey: '********'
publicKeyFingerprint: 820bad9cae9c1ef9eb2cfea20ebbfe3fe2eb4521
serialNumber: fa:a5:5d:ae:66:34:13:17
subjectCommonName: internal1024.internal1024
subjectCountry: US
subjectLocality: Pittsburgh
subjectOrganization: Sourcefire
subjectOrganizationUnit: Development
subjectState: PA
type: InternalCertificate
validityEndDate: '2025-03-07T15:45:51Z'
validityStartDate: '2015-03-10T15:45:51Z'
version: fe6b612c-83c8-11ec-a4d8-bd9354da7757
links:
self: https://172.29.182.90:10209/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcertificates?offset=0&limit=2&expanded=true
paging:
count: 3
limit: 2
next:
- https://172.29.182.90:10209/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcertificates?offset=2&limit=1&expanded=true
offset: 0
pages: 2
schema:
$ref: '#/components/schemas/InternalCertificateListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an internal certificate. _Check the response section for applicable examples (if any)._**'
operationId: createInternalCertificate
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/internalcertificates ( Test internal certificate creation )':
value:
cert: '-----BEGIN CERTIFICATE-----
MIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV
BAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE
ChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy
NDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3
MTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp
dHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs
MTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG
SIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg
x9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6
imwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt
8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC
sDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46
oYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0
dHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx
MDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT
FzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3
hGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko
42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu
rIuPFw==
-----END CERTIFICATE-----'
name: postman_cert_5
passPhrase: password
privateKey: REDACTED_PRIVATE_KEY_EXAMPLE
type: InternalCertificate
schema:
$ref: '#/components/schemas/InternalCertificate'
type: object
description: The input Internal Certificate model.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/internalcertificates ( Test internal certificate creation )':
value:
cert: '-----BEGIN CERTIFICATE-----
MIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV
BAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE
ChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy
NDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3
MTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp
dHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs
MTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG
SIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg
x9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6
imwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt
8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC
sDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46
oYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0
dHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx
MDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT
FzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3
hGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko
42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu
rIuPFw==
-----END CERTIFICATE-----'
certFingerprint: 50:9D:77:44:D4:A3:AC:3B:E1:F6:11:2E:85:19:15:0B:D0:D4:6B:D3
id: 2d615d16-96b5-11ec-a9ec-6765f7cbab59
issuerCommonName: internal1024.internal1024
issuerOrganization: Sourcefire
issuerOrganizationUnit: Development
links:
self: https://172.29.182.90:10209/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcertificates/2d615d16-96b5-11ec-a9ec-6765f7cbab59
name: postman_cert_5
passPhrase: '********'
privateKey: '********'
publicKeyFingerprint: 820bad9cae9c1ef9eb2cfea20ebbfe3fe2eb4521
serialNumber: fa:a5:5d:ae:66:34:13:17
subjectCommonName: internal1024.internal1024
subjectCountry: US
subjectLocality: Pittsburgh
subjectOrganization: Sourcefire
subjectOrganizationUnit: Development
subjectState: PA
type: InternalCertificate
validityEndDate: '2025-03-07T15:45:51Z'
validityStartDate: '2015-03-10T15:45:51Z'
version: 2e683018-96b5-11ec-a9ec-6765f7cbab59
schema:
$ref: '#/components/schemas/InternalCertificate'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/internalcertificates/{objectId}:
delete:
deprecated: false
description: '**Delete the internal certificate associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteInternalCertificate
parameters:
- description: Unique identifier of the internal certificate.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/object/internalcertificates/2d615d16-96b5-11ec-a9ec-6765f7cbab59
( Test DELETE of Internal Certificate )'
: value:
cert: '-----BEGIN CERTIFICATE-----
MIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV
BAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE
ChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy
NDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3
MTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp
dHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs
MTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG
SIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg
x9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6
imwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt
8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC
sDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46
oYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0
dHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx
MDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT
FzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3
hGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko
42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu
rIuPFw==
-----END CERTIFICATE-----'
certFingerprint: 50:9D:77:44:D4:A3:AC:3B:E1:F6:11:2E:85:19:15:0B:D0:D4:6B:D3
id: 004f971e-96bc-11ec-a6e0-6465f7cbab59
issuerCommonName: internal1024.internal1024
issuerOrganization: Sourcefire
issuerOrganizationUnit: Development
links:
self: https://172.29.182.90:10209/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcertificates/2d615d16-96b5-11ec-a9ec-6765f7cbab59
name: postman_cert_5_modified
passPhrase: '********'
privateKey: '********'
publicKeyFingerprint: 820bad9cae9c1ef9eb2cfea20ebbfe3fe2eb4521
serialNumber: fa:a5:5d:ae:66:34:13:17
subjectCommonName: internal1024.internal1024
subjectCountry: US
subjectLocality: Pittsburgh
subjectOrganization: Sourcefire
subjectOrganizationUnit: Development
subjectState: PA
type: InternalCertificate
validityEndDate: '2025-03-07T15:45:51Z'
validityStartDate: '2015-03-10T15:45:51Z'
version: 220bf15e-96bc-11ec-a6e0-6465f7cbab59
schema:
$ref: '#/components/schemas/InternalCertificate'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the internal certificate associated with the specified ID.**'
operationId: getInternalCertificate
parameters:
- description: Unique identifier of the internal certificate.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/internalcertificates/deba3c2c-83c8-11ec-b695-efd9b669047e
( Get InternalCertificate by id )'
: value:
cert: '-----BEGIN CERTIFICATE-----
MIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV
BAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE
ChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy
NDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3
MTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp
dHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs
MTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG
SIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg
x9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6
imwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt
8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC
sDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46
oYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0
dHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx
MDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT
FzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3
hGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko
42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu
rIuPFw==
-----END CERTIFICATE-----
'
certFingerprint: 50:9D:77:44:D4:A3:AC:3B:E1:F6:11:2E:85:19:15:0B:D0:D4:6B:D3
id: deba3c2c-83c8-11ec-b695-efd9b669047e
issuerCommonName: internal1024.internal1024
issuerOrganization: Sourcefire
issuerOrganizationUnit: Development
links:
self: https://172.29.182.90:10209/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcertificates/deba3c2c-83c8-11ec-b695-efd9b669047e
name: internal_cert_1
passPhrase: '********'
privateKey: '********'
publicKeyFingerprint: 820bad9cae9c1ef9eb2cfea20ebbfe3fe2eb4521
serialNumber: fa:a5:5d:ae:66:34:13:17
subjectCommonName: internal1024.internal1024
subjectCountry: US
subjectLocality: Pittsburgh
subjectOrganization: Sourcefire
subjectOrganizationUnit: Development
subjectState: PA
type: InternalCertificate
validityEndDate: '2025-03-07T15:45:51Z'
validityStartDate: '2015-03-10T15:45:51Z'
version: fe6b612c-83c8-11ec-a4d8-bd9354da7757
schema:
$ref: '#/components/schemas/InternalCertificate'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the internal certificate associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateInternalCertificate
parameters:
- description: Unique identifier of the internal certificate.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/internalcertificates/2d615d16-96b5-11ec-a9ec-6765f7cbab59
( Test PUT of Internal Certificate to update name )'
: value:
id: 2d615d16-96b5-11ec-a9ec-6765f7cbab59
name: postman_cert_5_modified
type: InternalCertificate
version: 220bf15e-96bc-11ec-a6e0-6465f7cbab59
schema:
$ref: '#/components/schemas/InternalCertificate'
type: object
description: The input Internal Certificate model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/internalcertificates/2d615d16-96b5-11ec-a9ec-6765f7cbab59
( Test PUT of Internal Certificate to update name )'
: value:
cert: '-----BEGIN CERTIFICATE-----
MIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV
BAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE
ChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy
NDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3
MTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp
dHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs
MTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG
SIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg
x9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6
imwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt
8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC
sDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46
oYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0
dHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx
MDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT
FzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3
hGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko
42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu
rIuPFw==
-----END CERTIFICATE-----'
certFingerprint: 50:9D:77:44:D4:A3:AC:3B:E1:F6:11:2E:85:19:15:0B:D0:D4:6B:D3
id: 004f971e-96bc-11ec-a6e0-6465f7cbab59
issuerCommonName: internal1024.internal1024
issuerOrganization: Sourcefire
issuerOrganizationUnit: Development
links:
self: https://172.29.182.90:10209/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/internalcertificates/2d615d16-96b5-11ec-a9ec-6765f7cbab59
name: postman_cert_5_modified
passPhrase: '********'
privateKey: '********'
publicKeyFingerprint: 820bad9cae9c1ef9eb2cfea20ebbfe3fe2eb4521
serialNumber: fa:a5:5d:ae:66:34:13:17
subjectCommonName: internal1024.internal1024
subjectCountry: US
subjectLocality: Pittsburgh
subjectOrganization: Sourcefire
subjectOrganizationUnit: Development
subjectState: PA
type: InternalCertificate
validityEndDate: '2025-03-07T15:45:51Z'
validityStartDate: '2015-03-10T15:45:51Z'
version: 220bf15e-96bc-11ec-a6e0-6465f7cbab59
schema:
$ref: '#/components/schemas/InternalCertificate'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/intrusionrulegroups:
get:
deprecated: false
description: '**Get the list of all Snort3 intrusion rule groups.**'
operationId: getAllSnort3IntrusionRuleGroupsObject
parameters:
- description: 'Value can be any of the formats (including quotes): "name:Browser/Firefox" or "currentSecurityLevel:DISABLED"
or "showonlyparents:{true/false}" or "isSystemDefined:{true/false}" or "includeCount:true".'
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/intrusionrulegroups ( Success: Test GET ALL method
for Snort3IntrusionRuleGroupsObjectObject )'
: value:
items:
- description: Rules for detecting exploits targeting Web browsers
id: fb1f3030-6070-5633-88eb-027660bbdba5
isSystemDefined: true
links:
self: https://u32c01p10-vrouter.cisco.com:10514/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/intrusionrulegroups/fb1f3030-6070-5633-88eb-027660bbdba5
metadata:
container:
id: c4f4121b-d8e0-5086-9ae3-064062109492
name: Rule Categories
type: IntrusionRuleGroup
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
name: Browser
parentGroup:
id: c4f4121b-d8e0-5086-9ae3-064062109492
name: Rule Categories
type: IntrusionRuleGroup
totalRuleCount: 0
type: IntrusionRuleGroup
- description: Contains the user defined rules
id: f2898aac-ee10-11ec-bfc5-67f7aebc82ad
isSystemDefined: true
links:
self: https://u32c01p10-vrouter.cisco.com:10514/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/intrusionrulegroups/f2898aac-ee10-11ec-bfc5-67f7aebc82ad
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
name: Local Rules
type: IntrusionRuleGroup
links:
self: https://u32c01p10-vrouter.cisco.com:10514/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/intrusionrulegroups?offset=1&limit=2&expanded=true
paging:
count: 2
limit: 2
offset: 1
pages: 1
prev:
- https://u32c01p10-vrouter.cisco.com:10514/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/intrusionrulegroups?offset=0&limit=1&expanded=true
schema:
$ref: '#/components/schemas/Snort3IntrusionRuleGroupsObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a Snort3 intrusion rule group. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleSnort3IntrusionRuleGroupsObject
parameters:
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/intrusionrulegroups ( Success: POST method for Snort3IntrusionRuleGroupsObject
with minimum required fields )'
: value:
description: Custom Intrusion Rule group1
name: Custom RuleGroup 1
type: IntrusionRuleGroup
schema:
$ref: '#/components/schemas/Snort3IntrusionRuleGroupsObject'
type: object
description: Input representation of Snort 3 rule group.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/intrusionrulegroups ( Success: POST method for
Snort3IntrusionRuleGroupsObject with minimum required fields )'
: value:
description: Custom Intrusion Rule group1
id: 0050568A-ED69-0ed3-0000-055834574910
isSystemDefined: false
links:
parent: https://u32c01p10-vrouter.cisco.com:10514/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/intrusionrulegroups
self: https://u32c01p10-vrouter.cisco.com:10514/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/intrusionrulegroups/0050568A-ED69-0ed3-0000-055834574910
name: Custom RuleGroup 1
type: IntrusionRuleGroup
schema:
$ref: '#/components/schemas/Snort3IntrusionRuleGroupsObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/intrusionrulegroups/{objectId}:
delete:
deprecated: false
description: '**Delete the Snort3 intrusion rule group associated with the specified ID. _Check the response section
for applicable examples (if any)._**'
operationId: deleteSnort3IntrusionRuleGroupsObject
parameters:
- description: Boolean indicating whether to delete orphan rules. Mandatory if a custom rulegroup has unique/unshared
rules which becomes orphan after the custom rule Group is deleted.
in: query
name: cascadeDeleteOrphanedRules
required: false
schema:
type: boolean
- description: Unique identifier of the Snort3 intrusion rule group.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Snort3IntrusionRuleGroupsObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the Snort3 intrusion rule group associated with the specified ID.**'
operationId: getSnort3IntrusionRuleGroupsObject
parameters:
- description: Unique identifier of the Snort3 intrusion rule group.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/intrusionrulegroups/Snort3IntrusionRuleGroupsObjectObject-UUID
( Success: Test GET method for Snort3IntrusionRuleGroupsObjectObject )'
: value:
childGroups:
- description: Rules for detecting multimedia traffic that may be against network policies
id: 1665f3dd-7586-5721-a510-a524394d5ec0
isSystemDefined: true
metadata:
container:
id: c4f4121b-d8e0-5086-9ae3-064062109492
name: Rule Categories
type: IntrusionRuleGroup
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
type: Domain
name: Multimedia
parentGroup:
id: 3b39d169-eff1-5ff7-9544-3bda90285601
name: Policy
type: IntrusionRuleGroup
totalRuleCount: 7
type: IntrusionRuleGroup
- description: Rules for detecting social media traffic that may be against network policies
id: 08673c2f-ee98-5925-9bbb-f86d7dcd7e7f
isSystemDefined: true
metadata:
container:
id: c4f4121b-d8e0-5086-9ae3-064062109492
name: Rule Categories
type: IntrusionRuleGroup
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
type: Domain
name: Social Media
parentGroup:
id: 3b39d169-eff1-5ff7-9544-3bda90285601
name: Policy
type: IntrusionRuleGroup
totalRuleCount: 81
type: IntrusionRuleGroup
- description: Rules for detecting miscellaneous traffic that may be against network policies
id: 968380d3-99b8-5578-84a2-b68fe9054711
isSystemDefined: true
metadata:
container:
id: c4f4121b-d8e0-5086-9ae3-064062109492
name: Rule Categories
type: IntrusionRuleGroup
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
type: Domain
name: Other
parentGroup:
id: 3b39d169-eff1-5ff7-9544-3bda90285601
name: Policy
type: IntrusionRuleGroup
totalRuleCount: 644
type: IntrusionRuleGroup
- description: Rules for detecting spam traffic
id: bb79c3d4-904e-569e-80ba-ad50a8f24c67
isSystemDefined: true
metadata:
container:
id: c4f4121b-d8e0-5086-9ae3-064062109492
name: Rule Categories
type: IntrusionRuleGroup
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
type: Domain
name: Spam
parentGroup:
id: 3b39d169-eff1-5ff7-9544-3bda90285601
name: Policy
type: IntrusionRuleGroup
totalRuleCount: 252
type: IntrusionRuleGroup
description: Rules for detecting activities that may not be malicious, but may be against network or corporate
policy
id: 3b39d169-eff1-5ff7-9544-3bda90285601
isSystemDefined: true
links:
parent: https://u32c01p10-vrouter.cisco.com:10514/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/intrusionrulegroups
self: https://u32c01p10-vrouter.cisco.com:10514/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/intrusionrulegroups/3b39d169-eff1-5ff7-9544-3bda90285601
metadata:
container:
id: c4f4121b-d8e0-5086-9ae3-064062109492
name: Rule Categories
type: IntrusionRuleGroup
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
name: Policy
schema:
$ref: '#/components/schemas/Snort3IntrusionRuleGroupsObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the Snort3 intrusion rule group associated with the specified ID. _Check the response section
for applicable examples (if any)._**'
operationId: updateSnort3IntrusionRuleGroupsObject
parameters:
- description: Unique identifier of the Snort3 intrusion rule group.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/intrusionrulegroups/Snort3IntrusionRuleGroupsObjectObject-UUID
( Success: Test PUT method for Snort3IntrusionRuleGroupsObjectObject )'
: value:
description: Updated Custom Intrusion Rule group1
name: Updated Custom RuleGroup 1
type: IntrusionRuleGroup
? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/object/intrusionrulegroups?bulk=true ( Success: Test Bulk
PUT method for Snort3IntrusionRuleGroupsObjectObject )'
: value:
- description: Updated Custom Intrusion Rule group1
name: Updated Custom RuleGroup 1
type: IntrusionRuleGroup
- description: Updated Custom Intrusion Rule group2
name: Updated Custom RuleGroup 2
type: IntrusionRuleGroup
schema:
$ref: '#/components/schemas/Snort3IntrusionRuleGroupsObject'
type: object
description: Input representation of Snort 3 rule group.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Snort3IntrusionRuleGroupsObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/intrusionrules:
delete:
deprecated: false
description: '**Delete all Snort3 intrusion rules. Use filtering to specify which rules will be deleted. _Check the
response section for applicable examples (if any)._**'
operationId: deleteMultipleSnort3IPSRulesObject
parameters:
- description: Boolean indicating whether this is a bulk operation. This parameter is required for bulk Snort 3 intrusion
rule operations.
in: query
name: bulk
required: true
schema:
type: boolean
- description: 'Value can be any of the formats (including quotes): "gid:123;sid:456" or "overrides:true;ipspolicy:{uuid1,uuid2,...}
or "fts:789" or "isSystemDefined:{true/false}". ipspolicy is a comma-separated
list of Snort 3 Intrusion Policy IDs.'
in: query
name: filter
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Snort3IPSRulesObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the list of all Snort3 intrusion rules.**'
operationId: getAllSnort3IPSRulesObject
parameters:
- description: 'Value can be any of the formats (including quotes): "gid:123;sid:456" or "overrides:true;ipspolicy:{uuid1,uuid2,...}
or "fts:789" or "isSystemDefined:{true/false}". ipspolicy is a comma-separated
list of Snort 3 Intrusion Policy IDs.'
in: query
name: filter
required: false
schema:
type: string
- description: Parameters to sort the list. Values can include sid, -sid, gid, -gid, msg, and -msg.
in: query
name: sort
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/intrusionrules ( Success: Test GET ALL method for
Snort3IPSRulesObject )'
: value:
items:
- gid: 2000
id: 0050568A-49A6-0ed3-0000-133143987005
isSystemDefined: false
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
msg: CUSTOM ICMP RULE7-upload
name: 2000:10001007
revision: 1
ruleAction:
- defaultState: DISABLE
overrideState: DROP
policy:
id: 0050568A-49A6-0ed3-0000-077309411377
isSystemDefined: false
name: IPS_HA
type: IntrusionPolicy
- defaultState: DISABLE
overrideState: BLOCK
policy:
id: 0050568A-49A6-0ed3-0000-077309413589
isSystemDefined: false
name: IPS_72
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 3c7d3f87-c264-504e-9a16-4a9cd5fc502c
isSystemDefined: true
name: Maximum Detection
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 0f9e8294-d03d-5b1f-a70c-549ca9213405
isSystemDefined: true
name: Security Over Connectivity
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 6c66b83c-bc23-55b6-879d-c4d847443503
isSystemDefined: true
name: Balanced Security and Connectivity
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 4cba6c52-6a07-54cd-a324-5bb7be06a484
isSystemDefined: true
name: Connectivity Over Security
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: ba8dc24f-f2a4-53dc-86b3-5252e5682579
isSystemDefined: true
name: No Rules Active
type: IntrusionPolicy
ruleData: alert icmp 100.1.1.106 any -> any any ( sid:10001007; gid:2000; msg:"CUSTOM ICMP RULE7-upload";
classtype:icmp-event; rev:1; )
ruleGroups:
- id: 0050568A-49A6-0ed3-0000-128849019544
name: CG1-NEW
type: IntrusionRuleGroup
sid: 10001007.0
type: IntrusionRule
links:
self: https://u32c01p10-vrouter.cisco.com:10514/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/intrusionrules?offset=0&limit=25&filter=sid:10001007&expanded=true
paging:
count: 1
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/Snort3IPSRulesObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a Snort3 intrusion rule. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleSnort3IPSRulesObject
parameters:
- description: Boolean indicating whether this is a bulk operation. This parameter is required for bulk Snort 3 intrusion
rule operations.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/intrusionrules ( Success: POST method for Snort3IPSRulesObject
with minimum required fields )'
: value:
ruleData: alert icmp any any -> any any ( sid:10000301; gid:2000; msg:"CUSTOM RULE1"; classtype:icmp-event;
rev:1; )
ruleGroups:
- id: 0050568A-7769-0ed3-0000-008589940030
name: CUSTOM_RULES
type: IntrusionRuleGroup
type: IntrusionRule
schema:
$ref: '#/components/schemas/Snort3IPSRulesObject'
type: object
description: Input representing snort 3 IPS rules object model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Snort3IPSRulesObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify all snort3 intrusion rules. _Check the response section for applicable examples (if any)._**'
operationId: updateMultipleSnort3IPSRulesObject
parameters:
- description: Boolean indicating whether this is a bulk operation. This parameter is required for bulk Snort 3 intrusion
rule operations.
in: query
name: bulk
required: true
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/intrusionrules/Snort3IPSRulesObject-UUID ( Success:
Test PUT method for Snort3IPSRulesObject )'
: value:
gid: 2000
id: 0050568A-7769-0ed3-0000-008589940125
isSystemDefined: false
msg: CUSTOM RULE1
name: 2000:10000301
revision: 1
ruleAction:
- defaultState: DISABLE
overrideState: BLOCK
policy:
id: 0050568A-7769-0ed3-0000-008589939827
isSystemDefined: false
name: ips3
type: IntrusionPolicy
- defaultState: DISABLE
overrideState: DROP
policy:
id: 0050568A-7769-0ed3-0000-008589936387
isSystemDefined: false
name: IPS
type: IntrusionPolicy
- defaultState: DISABLE
overrideState: ALERT
policy:
id: 0050568A-7769-0ed3-0000-008589939444
isSystemDefined: false
name: ips2
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 3c7d3f87-c264-504e-9a16-4a9cd5fc502c
isSystemDefined: true
name: Maximum Detection
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 0f9e8294-d03d-5b1f-a70c-549ca9213405
isSystemDefined: true
name: Security Over Connectivity
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 6c66b83c-bc23-55b6-879d-c4d847443503
isSystemDefined: true
name: Balanced Security and Connectivity
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 4cba6c52-6a07-54cd-a324-5bb7be06a484
isSystemDefined: true
name: Connectivity Over Security
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: ba8dc24f-f2a4-53dc-86b3-5252e5682579
isSystemDefined: true
name: No Rules Active
type: IntrusionPolicy
ruleData: alert icmp any any -> any any ( sid:10000301; gid:2000; msg:"CUSTOM RULE1"; classtype:icmp-event;
rev:1; )
ruleGroups:
- id: 0050568A-7769-0ed3-0000-008589940030
name: CUSTOM_RULES
type: IntrusionRuleGroup
sid: 10000301.0
type: IntrusionRule
? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/object/intrusionrules?bulk=true ( Success: Test Bulk PUT
method for Snort3IPSRulesObject )'
: value:
- gid: 2000
id: 0050568A-7769-0ed3-0000-008589940125
isSystemDefined: false
msg: CUSTOM RULE1
name: 2000:10000301
revision: 1
ruleAction:
- defaultState: DISABLE
overrideState: ALERT
policy:
id: 0050568A-7769-0ed3-0000-008589939827
isSystemDefined: false
name: ips3
type: IntrusionPolicy
- defaultState: DISABLE
overrideState: DROP
policy:
id: 0050568A-7769-0ed3-0000-008589936387
isSystemDefined: false
name: IPS
type: IntrusionPolicy
- defaultState: DISABLE
overrideState: BLOCK
policy:
id: 0050568A-7769-0ed3-0000-008589939444
isSystemDefined: false
name: ips2
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 3c7d3f87-c264-504e-9a16-4a9cd5fc502c
isSystemDefined: true
name: Maximum Detection
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 0f9e8294-d03d-5b1f-a70c-549ca9213405
isSystemDefined: true
name: Security Over Connectivity
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 6c66b83c-bc23-55b6-879d-c4d847443503
isSystemDefined: true
name: Balanced Security and Connectivity
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 4cba6c52-6a07-54cd-a324-5bb7be06a484
isSystemDefined: true
name: Connectivity Over Security
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: ba8dc24f-f2a4-53dc-86b3-5252e5682579
isSystemDefined: true
name: No Rules Active
type: IntrusionPolicy
ruleData: alert icmp any any -> any any ( sid:10000301; gid:2000; msg:"CUSTOM RULE1"; classtype:icmp-event;
rev:1; )
ruleGroups:
- id: 0050568A-7769-0ed3-0000-008589940030
name: CUSTOM_RULES
type: IntrusionRuleGroup
sid: 10000301.0
type: IntrusionRule
schema:
$ref: '#/components/schemas/Snort3IPSRulesObject'
type: object
description: Input representing snort 3 IPS rules object model.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Snort3IPSRulesObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/intrusionrules/{objectId}:
delete:
deprecated: false
description: '**Delete the Snort3 intrusion rule associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteSnort3IPSRulesObject
parameters:
- description: Unique identifier of the Snort3 intrusion rule.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Snort3IPSRulesObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the Snort3 intrusion rule associated with the specified ID.**'
operationId: getSnort3IPSRulesObject
parameters:
- description: Unique identifier of the Snort3 intrusion rule.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/intrusionrules/Snort3IPSRulesObject-UUID ( Success:
Test GET method for Snort3IPSRulesObject )'
: value:
gid: 2000
id: 0050568A-49A6-0ed3-0000-133143987005
isSystemDefined: false
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
msg: CUSTOM ICMP RULE7-upload
name: 2000:10001007
revision: 1
ruleAction:
- defaultState: DISABLE
overrideState: DROP
policy:
id: 0050568A-49A6-0ed3-0000-077309411377
isSystemDefined: false
name: IPS_HA
type: IntrusionPolicy
- defaultState: DISABLE
overrideState: BLOCK
policy:
id: 0050568A-49A6-0ed3-0000-077309413589
isSystemDefined: false
name: IPS_72
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 3c7d3f87-c264-504e-9a16-4a9cd5fc502c
isSystemDefined: true
name: Maximum Detection
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 0f9e8294-d03d-5b1f-a70c-549ca9213405
isSystemDefined: true
name: Security Over Connectivity
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 6c66b83c-bc23-55b6-879d-c4d847443503
isSystemDefined: true
name: Balanced Security and Connectivity
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 4cba6c52-6a07-54cd-a324-5bb7be06a484
isSystemDefined: true
name: Connectivity Over Security
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: ba8dc24f-f2a4-53dc-86b3-5252e5682579
isSystemDefined: true
name: No Rules Active
type: IntrusionPolicy
ruleData: alert icmp 100.1.1.106 any -> any any ( sid:10001007; gid:2000; msg:"CUSTOM ICMP RULE7-upload";
classtype:icmp-event; rev:1; )
ruleGroups:
- id: 0050568A-49A6-0ed3-0000-128849019544
name: CG1-NEW
type: IntrusionRuleGroup
sid: 10001007.0
type: IntrusionRule
schema:
$ref: '#/components/schemas/Snort3IPSRulesObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the Snort3 intrusion rule associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateSnort3IPSRulesObject
parameters:
- description: Unique identifier of the Snort3 intrusion rule.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/intrusionrules/Snort3IPSRulesObject-UUID ( Success:
Test PUT method for Snort3IPSRulesObject )'
: value:
gid: 2000
id: 0050568A-7769-0ed3-0000-008589940125
isSystemDefined: false
msg: CUSTOM RULE1
name: 2000:10000301
revision: 1
ruleAction:
- defaultState: DISABLE
overrideState: BLOCK
policy:
id: 0050568A-7769-0ed3-0000-008589939827
isSystemDefined: false
name: ips3
type: IntrusionPolicy
- defaultState: DISABLE
overrideState: DROP
policy:
id: 0050568A-7769-0ed3-0000-008589936387
isSystemDefined: false
name: IPS
type: IntrusionPolicy
- defaultState: DISABLE
overrideState: ALERT
policy:
id: 0050568A-7769-0ed3-0000-008589939444
isSystemDefined: false
name: ips2
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 3c7d3f87-c264-504e-9a16-4a9cd5fc502c
isSystemDefined: true
name: Maximum Detection
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 0f9e8294-d03d-5b1f-a70c-549ca9213405
isSystemDefined: true
name: Security Over Connectivity
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 6c66b83c-bc23-55b6-879d-c4d847443503
isSystemDefined: true
name: Balanced Security and Connectivity
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 4cba6c52-6a07-54cd-a324-5bb7be06a484
isSystemDefined: true
name: Connectivity Over Security
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: ba8dc24f-f2a4-53dc-86b3-5252e5682579
isSystemDefined: true
name: No Rules Active
type: IntrusionPolicy
ruleData: alert icmp any any -> any any ( sid:10000301; gid:2000; msg:"CUSTOM RULE1"; classtype:icmp-event;
rev:1; )
ruleGroups:
- id: 0050568A-7769-0ed3-0000-008589940030
name: CUSTOM_RULES
type: IntrusionRuleGroup
sid: 10000301.0
type: IntrusionRule
? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/object/intrusionrules?bulk=true ( Success: Test Bulk PUT
method for Snort3IPSRulesObject )'
: value:
- gid: 2000
id: 0050568A-7769-0ed3-0000-008589940125
isSystemDefined: false
msg: CUSTOM RULE1
name: 2000:10000301
revision: 1
ruleAction:
- defaultState: DISABLE
overrideState: ALERT
policy:
id: 0050568A-7769-0ed3-0000-008589939827
isSystemDefined: false
name: ips3
type: IntrusionPolicy
- defaultState: DISABLE
overrideState: DROP
policy:
id: 0050568A-7769-0ed3-0000-008589936387
isSystemDefined: false
name: IPS
type: IntrusionPolicy
- defaultState: DISABLE
overrideState: BLOCK
policy:
id: 0050568A-7769-0ed3-0000-008589939444
isSystemDefined: false
name: ips2
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 3c7d3f87-c264-504e-9a16-4a9cd5fc502c
isSystemDefined: true
name: Maximum Detection
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 0f9e8294-d03d-5b1f-a70c-549ca9213405
isSystemDefined: true
name: Security Over Connectivity
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 6c66b83c-bc23-55b6-879d-c4d847443503
isSystemDefined: true
name: Balanced Security and Connectivity
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: 4cba6c52-6a07-54cd-a324-5bb7be06a484
isSystemDefined: true
name: Connectivity Over Security
type: IntrusionPolicy
- defaultState: DISABLE
policy:
id: ba8dc24f-f2a4-53dc-86b3-5252e5682579
isSystemDefined: true
name: No Rules Active
type: IntrusionPolicy
ruleData: alert icmp any any -> any any ( sid:10000301; gid:2000; msg:"CUSTOM RULE1"; classtype:icmp-event;
rev:1; )
ruleGroups:
- id: 0050568A-7769-0ed3-0000-008589940030
name: CUSTOM_RULES
type: IntrusionRuleGroup
sid: 10000301.0
type: IntrusionRule
schema:
$ref: '#/components/schemas/Snort3IPSRulesObject'
type: object
description: Input representing snort 3 IPS rules object model.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Snort3IPSRulesObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/intrusionrulesupload:
post:
deprecated: false
description: '**Import custom Snort3 intrusion rules. _Check the response section for applicable examples (if any)._**'
operationId: createSnort3IPSRulesFileUpload
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
multipart/form-data:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/intrusionrulesupload ( Success: Test POST method
for Snort3IPSRulesFileUpload )'
: value:
payloadFile: .rules or .txt format Snort3 rule file
ruleGroups: group-id1,group-id2,group-id3
ruleImportMode: ENUM (MERGE, REPLACE)
validateOnly: TRUE or FALSE
schema:
properties:
payloadFile:
description: File containing the custom Snort 3 intrusion rules. .rules and .txt are supported
file formats.*required
format: binary
type: string
ruleComment:
description: Rule comment.
type: string
ruleGroups:
description: Comma-separated list of rulegroups to which rules should be associated. Example are group-id1,group-id2.
type: string
ruleImportMode:
description: Enums used to add, update or replace the rules in the rulegroups.MERGE and REPLACE
are supported enums.*required
type: string
validateOnly:
description: Boolean identifier to validate or import rules. true is the default value.
type: boolean
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Snort3IPSRulesFileUpload'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ipv4addresspools:
get:
deprecated: false
description: '**Get the list of all IPv4 address pools.**'
operationId: getAllIPv4AddressPool
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/ipv4addresspools?limit=2&expanded=false ( Get all
paginated IPv4AddressPool objects with limit set 2 and expanded is set to flase )'
: value:
items:
- id: IPv4AddressPool-1UUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ipv4addresspools/ipv4addresspoolUUID
name: IPv4AddressPool-1
type: IPv4AddressPool
- id: IPv4AddressPool-2UUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ipv4addresspools/ipv4addresspoolUUID
name: IPv4AddressPool-2
type: IPv4AddressPool
links:
self: /fmc_config/v1/domain/DomainUUID/object/ipv4addresspools?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/ipv4addresspools?limit=2&expanded=true ( Get all
paginated ipv4addresspool objects with limit set 2 and expanded is set to true )'
: value:
items:
- description: IPv4AddressPool object description
id: IPv4AddressPool-1UUID
ipAddressRange: 10.72.1.10-10.72.1.150
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ipv4addresspools/ipv4addresspoolUUID
mask: 255.255.255.0
metadata:
domain:
id: domainUUID
name: Global \ INDIA
type: Domain
lastUser:
name: user1
timestamp: number
name: IPv4AddressPool-1
overridable: true
type: IPv4AddressPool
- addressType: SUPERNET
description: IPv4AddressPool object description
id: IPv4AddressPool-2UUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ipv4addresspools/ipv4addresspoolUUID
metadata:
domain:
id: domainUUID
name: Global \ INDIA \ Chennai
type: Domain
lastUser:
name: user1
timestamp: number
name: IPv4AddressPool-2
numberOfAddresses: 50
overridable: true
rangeStart: 1
subnetPrefix: 24
supernetAddress: 10.10.0.0
supernetPrefix: 16
type: IPv4AddressPool
links:
self: /fmc_config/v1/domain/DomainUUID/object/ipv4addresspools?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/IPv4AddressPoolListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an IPv4 address pool. _Check the response section for applicable examples (if any)._**'
operationId: createIPv4AddressPool
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/ipv4addresspools/ ( POST a IPv4AddressPool. )':
value:
addressType: SUPERNET
description: ' '
name: adpoolNW_51
numberOfAddresses: 50
overridable: true
rangeStart: 1
subnetPrefix: 24
supernetAddress: 10.10.0.0
supernetPrefix: 16
type: IPv4AddressPool
'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/ipv4addresspools/ ( POST a IPv4AddressPool. )':
value:
description: ' '
ipAddressRange: 10.10.19.10-10.10.19.20
mask: 255.255.255.192
name: adpool
overridable: true
type: IPv4AddressPool
schema:
$ref: '#/components/schemas/IPv4AddressPool'
type: object
description: The input IPv4 Address Pool object model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/IPv4AddressPool'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ipv4addresspools/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all overrides on an IPv4 address pool. Response will always be in expanded form. If passed, the
"expanded" query parameter will be ignored.**'
operationId: getIPv4AddressPoolOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/ipv4addresspools/ipv4addresspoolUUID/overrides
( Get all overrides on given IPv4AddressPool objects )'
: value:
items:
- description: IPv6AddressPool object description
id: IPV4_2UUID
ipAddressRange: 10.72.1.10-10.72.1.150
links:
self: /fmc_config/v1/domain/domainUUID/object/ipv4addresspools/ipv4addresspoolUUID?overrideTargetId=targetUUID
mask: 255.255.255.0
metadata:
domain:
id: domainUUID
name: Global \ INDIA \ BENGALURU
lastUser:
name: user1
timestamp: number
name: IPV4_2
overridable: true
overrides:
parent:
id: ipv4addresspoolUUID
type: IPv4AddressPool
target:
id: targetUUID
name: 10.10.19.27
type: Device
type: IPv4AddressPool
links:
self: /fmc_config/v1/domain/domainUUID/object/ipv4addresspools/ipv4addresspoolUUID/overrides?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/IPv4AddressPoolOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ipv4addresspools/{objectId}:
delete:
deprecated: false
description: '**Delete the IPv4 address pool associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteIPv4AddressPool
parameters:
- description: Unique identifier of the IPv4 address pool.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/ipv4addresspools/IPv4AddressPoolUUID ( Delete
a IPv4AddressPool Object for the given UUID. )'
: value:
description: ' '
id: IPv4AddressPoolUUID
ipAddressRange: 10.10.19.10-10.10.19.20
links:
parent: /fmc_config/v1/domain/default/object/
self: /fmc_config/v1/domain/DomainUUID/object/ipv4addresspools/IPv4AddressPoolUUID
mask: 255.255.255.192
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1613995959773.0
name: adpool
overridable: true
type: IPv4AddressPool
schema:
$ref: '#/components/schemas/IPv4AddressPool'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the IPv4 address pool associated with the specified ID.**'
operationId: getIPv4AddressPool
parameters:
- description: Unique identifier of the IPv4 address pool.
in: path
name: objectId
required: true
schema:
type: string
- description: Get the overrides associated with the specified IPv4 Address Pool object.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/ipv4addresspools/ipv4addresspoolUUID ( Get ipv4addresspool
object by id )'
: value:
addressType: RANGE
description: IPv4AddressPool object description
id: IPv4AddressPool-1UUID
ipAddressRange: 10.72.1.10-10.72.1.150
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ipv4addresspools/ipv4addresspoolUUID
mask: 255.255.255.0
metadata:
domain:
id: domainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: number
name: IPv4AddressPool-1
overridable: true
type: IPv4AddressPool
schema:
$ref: '#/components/schemas/IPv4AddressPool'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the IPv4 address pool associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateIPv4AddressPool
parameters:
- description: Unique identifier of the IPv4 address pool.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/ipv4addresspools/IPv4AddressPoolUUID ( PUT a IPv4AddressPool. )':
value:
description: ' '
id: 00505686-154A-0ed3-0000-008589935142
ipAddressRange: 10.10.19.10-10.10.19.20
mask: 255.255.255.192
name: adpool
overridable: true
type: IPv4AddressPool
schema:
$ref: '#/components/schemas/IPv4AddressPool'
type: object
description: The input IPv4 Address Pool object model.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/IPv4AddressPool'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ipv4prefixlists:
get:
deprecated: false
description: '**Get the list of all IPv4 prefix lists.**'
operationId: getAllIPv4PrefixList
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET null ( Test GET All of IPV4PrefixList Object )':
value:
items:
- description: ' '
entries:
- action: PERMIT
ipAddress: 1.0.0.0/13
sequence: 131
- action: PERMIT
ipAddress: 1.1.0.0/23
sequence: 132
id: ipv4prefixlistsObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/ipv4prefixlists/ipv4prefixlistsObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1622020292000.0
name: IPv4PrefixListTestA
overridable: true
type: IPV4PrefixList
- description: ' '
entries:
- action: PERMIT
ipAddress: 10.10.16.0/20
maxPrefixLength: 25
minPrefixLenth: 21
sequence: 30
id: ipv4prefixlistsObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/ipv4prefixlists/ipv4prefixlistsObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1622028975810.0
name: IPv4PrefixListTestB
overridable: false
type: IPV4PrefixList
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/ipv4prefixlists?offset=0&limit=25&expanded=true
paging:
count: 2
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/IPv4PrefixListListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an IPv4 prefix list. _Check the response section for applicable examples (if any)._**'
operationId: createIPv4PrefixList
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST null ( Test POST of IPV4PrefixList Object )':
value:
entries:
- action: PERMIT
ipAddress: 11.11.11.11/20
maxPrefixLength: 24
minPrefixLenth: 22
sequence: 50
name: IPv4PrefixListTestC
schema:
$ref: '#/components/schemas/IPv4PrefixList'
type: object
description: Input representation of IPv4 Prefix List object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST null ( Test POST of IPV4PrefixList Object )':
value:
description: ' '
entries:
- action: PERMIT
ipAddress: 11.11.0.0/20
maxPrefixLength: 24
minPrefixLenth: 22
sequence: 50
id: ipv4prefixlistsObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/ipv4prefixlists/ipv4prefixlistsObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 0
name: IPv4PrefixListTestC
overridable: false
type: IPV4PrefixList
schema:
$ref: '#/components/schemas/IPv4PrefixList'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ipv4prefixlists/{objectId}:
delete:
deprecated: false
description: '**Delete the IPv4 prefix list associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteIPv4PrefixList
parameters:
- description: Unique identifier of the IPv4 prefix list.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : DELETE null ( Test DELETE of IPV4PrefixList Object )':
value:
description: ' '
entries:
- action: PERMIT
ipAddress: 11.11.11.0/25
maxPrefixLength: 28
minPrefixLenth: 26
sequence: 101
id: ipv4prefixlistsObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/ipv4prefixlists/ipv4prefixlistsObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 0
name: IPv4PrefixListTestC
overridable: false
type: IPV4PrefixList
schema:
$ref: '#/components/schemas/IPv4PrefixList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the IPv4 prefix list associated with the specified ID.**'
operationId: getIPv4PrefixList
parameters:
- description: Unique identifier of the IPv4 prefix list.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET null ( Test GET of IPV4PrefixList Object )':
value:
description: ' '
entries:
- action: PERMIT
ipAddress: 10.10.16.0/20
maxPrefixLength: 28
minPrefixLenth: 22
sequence: 34
id: ipv4prefixlistsObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/ipv4prefixlists/ipv4prefixlistsObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: rest
timestamp: 1562681938190.0
name: '213'
overridable: true
type: IPV4PrefixList
schema:
$ref: '#/components/schemas/IPv4PrefixList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the IPv4 prefix list associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateIPv4PrefixList
parameters:
- description: Unique identifier of the IPv4 prefix list.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : PUT null ( Test PUT of IPV4PrefixList Object )':
value:
entries:
- action: PERMIT
ipAddress: 11.11.11.11/25
maxPrefixLength: 28
minPrefixLenth: 26
sequence: 101
id: ipv4prefixlistsObjectUUID
name: IPv4PrefixListTestC
schema:
$ref: '#/components/schemas/IPv4PrefixList'
type: object
description: Input representation of IPv4 Prefix List object.
required: true
responses:
'200':
content:
application/json:
examples:
'Example 1 : PUT null ( Test PUT of IPV4PrefixList Object )':
value:
description: ' '
entries:
- action: PERMIT
ipAddress: 11.11.11.0/25
maxPrefixLength: 28
minPrefixLenth: 26
sequence: 101
id: ipv4prefixlistsObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/ipv4prefixlists/ipv4prefixlistsObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 0
name: IPv4PrefixListTestC
overridable: false
type: IPV4PrefixList
schema:
$ref: '#/components/schemas/IPv4PrefixList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ipv6addresspools:
get:
deprecated: false
description: '**Get the list of all IPv6 address pools.**'
operationId: getAllIPv6AddressPool
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/ipv6addresspools?limit=2&expanded=true ( Get all
paginated ipv6addresspool objects with limit set 2 and expanded is set to true )'
: value:
items:
- description: IPv6AddressPool object description
id: IPv6AddressPool-1UUID
ipv6StartAddress: fd70::5/64
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ipv6addresspools/ipv6addresspoolUUID
metadata:
domain:
id: domainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: number
name: IPv6AddressPool-1
numberOfAddresses: 20
type: IPv6AddressPool
- description: IPv6AddressPool object description
id: IPv6AddressPool-2UUID
ipv6StartAddress: 2001:DB8::1/32
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ipv6addresspools/ipv6addresspoolUUID
metadata:
domain:
id: domainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: number
name: IPv6AddressPool-2
numberOfAddresses: 100
type: IPv6AddressPool
links:
self: /fmc_config/v1/domain/DomainUUID/object/ipv6addresspools?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/ipv6addresspools?limit=2&expanded=false ( Get all
paginated ipv6addresspool objects with limit set 2 and expanded is set to false )'
: value:
items:
- id: IPv6AddressPool-1UUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ipv6addresspools/ipv6addresspoolUUID
name: IPv6AddressPool-1
type: IPv6AddressPool
- id: IPv6AddressPool-2UUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ipv6addresspools/ipv6addresspoolUUID
name: IPv6AddressPool-2
type: IPv6AddressPool
links:
self: /fmc_config/v1/domain/DomainUUID/object/ipv6addresspools?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/IPv6AddressPoolListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an IPv6 address pool. _Check the response section for applicable examples (if any)._**'
operationId: createIPv6AddressPool
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IPv6AddressPool'
type: object
description: The input IPv6 Address Pool object model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/IPv6AddressPool'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ipv6addresspools/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all overrides on an IPv6 address pool. Response will always be in expanded form. If passed, the
"expanded" query parameter will be ignored.**'
operationId: getIPv6AddressPoolOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/ipv6addresspools/ipv6addresspoolUUID/overrides
( Get all overrides for ipv6 address pool object )'
: value:
items:
- description: IPv6AddressPool object description
id: Ipv6-1UUID
ipv6StartAddress: 2001:DB8::1/32
links:
self: /fmc_config/v1/domain/domainUUID/object/ipv6addresspools/ipv6addresspoolUUID?overrideTargetId=targetUUID
metadata:
domain:
id: domainUUID
name: Global \ INDIA
lastUser:
name: user1
timestamp: number
name: Ipv6-1
numberOfAddresses: 1
overridable: true
overrides:
parent:
id: ipv6addresspoolUUID
type: IPv6AddressPool
target:
id: targetUUID
name: 10.10.19.25
type: Device
type: IPv6AddressPool
links:
self: /fmc_config/v1/domain/domainUUID/object/ipv6addresspools/ipv6addresspoolUUID/overrides?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/IPv6AddressPoolOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ipv6addresspools/{objectId}:
delete:
deprecated: false
description: '**Delete the IPv6 address pool associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteIPv6AddressPool
parameters:
- description: Unique identifier of the IPv6 address pool.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/IPv6AddressPool'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the IPv4 address pool associated with the specified ID.**'
operationId: getIPv6AddressPool
parameters:
- description: Unique identifier of the IPv6 address pool.
in: path
name: objectId
required: true
schema:
type: string
- description: Get the overrides associated with the specified IPv6 Address Pool object.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/ipv6addresspools/ipv6addresspoolUUID ( Get IPv6pools
object by id )'
: value:
description: IPv6AddressPool object description
id: IPv6AddressPool-1lUUID
ipv6StartAddress: 2001:DB8::1/32
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ipv6addresspools/ipv6addresspoolUUID
metadata:
domain:
id: domainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: number
name: IPv6AddressPool-1
numberOfAddresses: 10
overridable: true
type: IPv6AddressPool
schema:
$ref: '#/components/schemas/IPv6AddressPool'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the IPv6 address pool associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateIPv6AddressPool
parameters:
- description: Unique identifier of the IPv6 address pool.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IPv6AddressPool'
type: object
description: The input IPv6 Address Pool object model.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/IPv6AddressPool'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ipv6prefixlists:
get:
deprecated: false
description: '**Get the list of all IPv6 prefix lists.**'
operationId: getAllIPv6PrefixList
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET null ( Test GET All of IPV6PrefixList Object )':
value:
items:
- description: ' '
entries:
- action: PERMIT
ipAddress: fe81::abcd/10
maxPrefixLength: 50
minPrefixLenth: 45
sequence: 131
- action: PERMIT
ipAddress: fe82::abcd/10
maxPrefixLength: 60
minPrefixLenth: 55
sequence: 132
id: ipv6prefixlistsObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/ipv6prefixlists/ipv6prefixlistsObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1622020292000.0
name: IPv6PrefixListTestA
overridable: true
type: IPV6PrefixList
- description: ' '
entries:
- action: PERMIT
ipAddress: fe83::abcd/10
maxPrefixLength: 25
minPrefixLenth: 20
sequence: 30
id: ipv6prefixlistsObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/ipv6prefixlists/ipv6prefixlistsObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1622028975810.0
name: IPv6PrefixListTestB
overridable: false
type: IPV6PrefixList
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/ipv6prefixlists?offset=0&limit=25&expanded=true
paging:
count: 2
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/IPv6PrefixListListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an IPv6 prefix list. _Check the response section for applicable examples (if any)._**'
operationId: createIPv6PrefixList
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST null ( Test POST of IPV6PrefixList Object )':
value:
entries:
- action: PERMIT
ipAddress: fe83::abcd/50
maxPrefixLength: 70
minPrefixLenth: 60
sequence: 130
name: IPv6PrefixListTestC
schema:
$ref: '#/components/schemas/IPv6PrefixList'
type: object
description: Input representation of IPv6 Prefix List object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST null ( Test POST of IPV6PrefixList Object )':
value:
description: ' '
entries:
- action: PERMIT
ipAddress: fe83::abcd/50
maxPrefixLength: 70
minPrefixLenth: 60
sequence: 130
id: ipv6prefixlistsObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/ipv6prefixlists/ipv6prefixlistsObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 0
name: IPv6PrefixListTestC
overridable: false
type: IPV6PrefixList
schema:
$ref: '#/components/schemas/IPv6PrefixList'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ipv6prefixlists/{objectId}:
delete:
deprecated: false
description: '**Delete the IPv6 prefix list associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteIPv6PrefixList
parameters:
- description: Unique identifier of the IPv6 prefix list.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : DELETE null ( Test DELETE of IPV6PrefixList Object )':
value:
description: ' '
entries:
- action: PERMIT
ipAddress: fe83::/10
maxPrefixLength: 15
minPrefixLenth: 14
sequence: 35
id: ipv6prefixlistsObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/ipv6prefixlists/ipv6prefixlistsObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 0
name: IPv6PrefixListTestC
overridable: false
type: IPV6PrefixList
schema:
$ref: '#/components/schemas/IPv6PrefixList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the IPv6 prefix list associated with the specified ID.**'
operationId: getIPv6PrefixList
parameters:
- description: Unique identifier of the IPv6 prefix list.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET null ( Test GET of IPV6PrefixLists Object )':
value:
description: ' '
entries:
- action: PERMIT
ipAddress: fe80::/10
maxPrefixLength: 40
minPrefixLenth: 30
sequence: 23
id: ipv6prefixlistsObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/ipv6prefixlists/object/ipv6prefixlistsObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: rest
timestamp: 1562738794453.0
name: '253'
overridable: true
type: IPV6PrefixList
schema:
$ref: '#/components/schemas/IPv6PrefixList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the IPv6 prefix list associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateIPv6PrefixList
parameters:
- description: Unique identifier of the IPv6 prefix list.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : PUT null ( Test PUT of IPV6PrefixList Object )':
value:
entries:
- action: PERMIT
ipAddress: fe83::/10
maxPrefixLength: 15
minPrefixLenth: 14
sequence: 35
id: ipv6prefixlistsObjectUUID
name: IPv6PrefixListTestC
schema:
$ref: '#/components/schemas/IPv6PrefixList'
type: object
description: Input representation of IPv6 Prefix List object.
required: true
responses:
'200':
content:
application/json:
examples:
'Example 1 : PUT null ( Test PUT of IPV6PrefixList Object )':
value:
description: ' '
entries:
- action: PERMIT
ipAddress: fe83::/10
maxPrefixLength: 15
minPrefixLenth: 14
sequence: 35
id: ipv6prefixlistsObjectUUID
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/ipv6prefixlists/ipv6prefixlistsObjectUUID
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
type: Domain
lastUser:
name: admin
timestamp: 0
name: IPv6PrefixListTestC
overridable: false
type: IPV6PrefixList
schema:
$ref: '#/components/schemas/IPv6PrefixList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/isesecuritygrouptags:
get:
deprecated: false
description: '**Get the list of all ISE security group tags.**'
operationId: getAllISESecurityGroupTag
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/exampledomainuuid/object/isesecuritygrouptags ( Success: Test GET
ALL success of all ISE Security Group Tags )'
: value:
items:
- id: exampleisesgtuuid
links:
self: /fmc_config/v1/domain/exampledomainuuid/object/isesecuritygrouptags/exampleisesgtuuid
name: ExampleISESGTname
type: ISESecurityGroupTag
- id: exampleisesgtuuid2
links:
self: /fmc_config/v1/domain/exampledomainuuid/object/isesecuritygrouptags/exampleisesgtuuid2
name: ExampleISESGTname2
type: ISESecurityGroupTag
links:
self: /fmc_config/v1/domain/exampledomainuuid/object/isesecuritygrouptags?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/exampledomainuuid/object/isesecuritygrouptags?expanded=true ( Success:
Test GET ALL success with expanded=true )'
: value:
items:
- description: example description.
id: exampleisesgtuuid
links:
self: https://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/isesecuritygrouptags/exampleisesgtuuid
name: ExampleISESGTname
tag: 0
type: ISESecurityGroupTag
- description: example description.2
id: exampleisesgtuuid2
links:
self: https://example.com:443/api/fmc_config/v1/domain/exampledomainuuid/object/isesecuritygrouptags/exampleisesgtuuid2
metadata:
domain:
id: testdomainuuid2
name: TestDomain2
type: Domain
lastUser:
id: testuseruuid2
name: testuser2
type: User
readOnly:
state: true
timestamp: Sat Jan 17 20:30:39 UTC 1970
name: ExampleISESGTname2
tag: 0
type: ISESecurityGroupTag
links:
self: /fmc_config/v1/domain/exampledomainuuid/object/isesecuritygrouptags?expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ISESecurityGroupTagListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/isesecuritygrouptags/{objectId}:
get:
deprecated: false
description: '**Get the ISE security group tag with the specified ID.**'
operationId: getISESecurityGroupTag
parameters:
- description: Unique identifier of the ISE security group tag.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ISESecurityGroupTag'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/keychains:
get:
deprecated: false
description: '**Get the list of all keychain objects.**'
operationId: getAllKeyChainObject
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/object/keychain ( Get all paginated Key Chain objects )':
value:
items:
- id: KeyChainUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID
name: KeyChainObjectName1
type: KeyChainObject
- id: KeyChainUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID
name: KeyChainObjectName2
type: KeyChainObject
- id: KeyChainUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID
name: KeyChainObjectName3
type: KeyChainObject
links:
self: api/fmc_config/v1/domain/DomainUUID/object/keychain?offset=0&limit=3
paging:
count: 3
limit: 3
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/object/keychain?expanded=true ( Get all paginated
Key Chain objects )'
: value:
items:
- description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1524118335170.0
name: KeyChainObjectName1
type: KeyChainObject
- description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1523597066886.0
name: KeyChainObjectName2
type: KeyChainObject
- description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1524118310520.0
name: KeyChainObjectName3
type: KeyChainObject
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain?offset=0&limit=3&expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/KeyChainObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a keychain object. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleKeyChainObject
parameters:
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain ( POST method for Key Chain Object )':
value:
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 24
sendLifeTime:
endLifetimeType: INFINITE
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 3
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 34
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 4
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 5
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
name: KeyChainObjectName1
overridable: false
type: KeyChainObject
'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain?bulk=true ( POST method for Key Chain Bulk Object )':
value:
- description: desciption
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
name: KeyChain1
type: KeyChainObject
- description: desciption
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
name: keychain2
type: KeyChainObject
? 'Example 3 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain?bulk=true ( POST method for Key Chain
Object with Bulk Override )'
: value:
- description: override_keychain_rest_5
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 2
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 3
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
name: parent_keychain_rest_6
overridable: true
overrides:
parent:
id: KeyChainUUID
type: KeyChainObject
target:
id: DeviceUUID
name: DeviceName
type: Device
type: KeyChainObject
- description: override_keychain_rest_6
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 2
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 3
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
name: parent_keychain_rest_6
overridable: true
overrides:
parent:
id: KeyChainUUID
type: KeyChainObject
target:
id: DomainUUID
name: DomainName
type: Domain
type: KeyChainObject
? 'Example 4 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain ( POST method for Key Chain override
Object with device )'
: value:
description: description for keychain object
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 24
sendLifeTime:
endLifetimeType: INFINITE
startLifeTimeValue: 2018-08-25 12:14:23
name: KeyChainObjectName1
overridable: true
overrides:
parent:
id: KeyChainUUID
type: KeyChainObject
target:
id: deviceUUID
name: 10.10.9.20
type: Device
type: KeyChainObject
? 'Example 5 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain ( POST method for Key Chain Object
override with domain )'
: value:
description: description for keychain object
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 24
sendLifeTime:
endLifetimeType: INFINITE
startLifeTimeValue: 2018-08-25 12:14:23
name: KeyChainObjectName1
overridable: true
overrides:
parent:
id: KeyChainUUID
type: KeyChainObject
target:
id: domainUUID
name: Global \ ASIA \ INDIA
type: Domain
type: KeyChainObject
schema:
$ref: '#/components/schemas/KeyChainObject'
type: object
description: Input representation of KeyChain object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain ( POST method for Key Chain Object )':
value:
description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: INFINITE
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 24
sendLifeTime:
endLifetimeType: INFINITE
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 3
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 34
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 4
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 5
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 0
name: KeyChainObjectName1
overridable: false
timeout: 3
type: KeyChainObject
'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain?bulk=true ( POST method for Key Chain Bulk Object )':
value:
items:
- description: desciption
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychains/KeyChainUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: admin
timestamp: 0
name: KeyChain1
overridable: false
type: KeyChainObject
- description: desciption
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychains/KeyChainUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: admin
timestamp: 0
name: keychain2
overridable: false
type: KeyChainObject
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychains?bulk=true
? 'Example 3 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain?bulk=true ( POST method for Key Chain
Object with Bulk Override )'
: value:
items:
- description: override_keychain_rest_5
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 2
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 3
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychains/KeyChainUUID?overrideTargetId=DeviceUUID
metadata:
domain:
id: DomainUUID
name: Global \ Domain_Network
lastUser:
name: admin
timestamp: 0
name: parent_keychain_rest_6
overridable: true
overrides:
parent:
id: ParentKeyChainUUID
type: KeyChainObject
target:
id: DeviceUUID
name: DeviceName
type: Device
type: KeyChainObject
- description: override_keychain_rest_6
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 2
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
- acceptLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: plaintext
keyId: 3
sendLifeTime:
endLifeTimeValue: 2018-09-15 15:53:00
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-15 15:53:00
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychains/KeyChainUUID?overrideTargetId=DeviceUUID
metadata:
domain:
id: DomainUUID
name: Global \ Domain_Network
lastUser:
name: admin
timestamp: 0
name: parent_keychain_rest_6
overridable: true
overrides:
parent:
id: ParentKeyChainUUID
type: KeyChainObject
target:
id: DomainUUID
name: DomainName
type: Domain
type: KeyChainObject
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychains?bulk=true
? 'Example 4 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain ( POST method for Key Chain override
Object with device )'
: value:
description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: INFINITE
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 24
sendLifeTime:
endLifetimeType: INFINITE
startLifeTimeValue: 2018-08-25 12:14:23
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID?overrideTargetId=deviceUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 0
name: KeyChainObjectName1
overridable: true
overrides:
parent:
id: KeyChainUUID
type: KeyChainObject
target:
id: deviceUUID
name: 10.10.9.20
type: Device
timeout: 3
type: KeyChainObject
? 'Example 5 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain ( POST method for Key Chain Object
override with domain )'
: value:
description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: INFINITE
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 24
sendLifeTime:
endLifetimeType: INFINITE
startLifeTimeValue: 2018-08-25 12:14:23
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID?overrideTargetId=deviceUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 0
name: KeyChainObjectName1
overridable: true
overrides:
parent:
id: KeyChainUUID
type: KeyChainObject
target:
id: domainUUID
name: Global \ ASIA \ INDIA
type: Domain
timeout: 3
type: KeyChainObject
schema:
$ref: '#/components/schemas/KeyChainObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/keychains/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all overrides on the KeyChain object. Response will always be in expanded form. If passed, the "expanded"
query parameter will be ignored.**'
operationId: getAllKeyChainObjectOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/keychain/keyChainUUID/overrides ( Get all overrides
on given Key Chain objects )'
: value:
items:
- description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
links:
self: /fmc_config/v1/domain/domainUUID/object/keychain/keyChainUUID?overrideTargetId=targetUUID
metadata:
domain:
id: domainUUID
name: Global \ INDIA \ BENGALURU
lastUser:
name: user1
timestamp: 1520419867090.0
name: KeyChainObjectName1
overridable: true
overrides:
parent:
id: KeyChainUUID
type: KeyChainObject
target:
id: deviceUUID
name: 10.10.9.20
type: Device
type: KeyChainObject
links:
self: /fmc_config/v1/domain/domainUUID/object/keychain/keyChainUUID/overrides?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/KeyChainObjectOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/keychains/{containerUUID}/overrides/{objectId}:
get:
deprecated: false
description: '**Get the specified override of Key chain object. Response will always be in expanded form. If passed,
the "expanded" query parameter will be ignored.**'
operationId: getKeyChainObjectOverride
parameters:
- description: Unique identifier of the keychain override object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/KeyChainObjectOverride'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/keychains/{objectId}:
delete:
deprecated: false
description: '**Delete the keychain object associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteKeyChainObject
parameters:
- description: Unique identifier of the keychain object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID ( DELETE method for
Key Chain Object )'
: value:
description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1524129145233.0
name: KeyChainObjectName1
type: KeyChainObject
schema:
$ref: '#/components/schemas/KeyChainObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the keychain object associated with the specified ID.**'
operationId: getKeyChainObject
parameters:
- description: Unique identifier of the keychain object.
in: path
name: objectId
required: true
schema:
type: string
- description: Get the overrides associated with the specified Key chain object.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID ( Get KeyChain object by id )':
value:
description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1523597066886.0
name: KeyChainObjectName1
overridable: false
type: KeyChainObject
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID ( Get KeyChain object
overrides by device id )'
: value:
description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID?overrideTargetId=deviceUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1523597066886.0
name: KeyChainObjectName1
overridable: true
overrides:
parent:
id: KeyChainUUID
type: KeyChainObject
target:
id: deviceUUID
name: 10.10.9.20
type: Device
type: KeyChainObject
? 'Example 3 : GET /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID ( Get KeyChain object
overrides by domain id )'
: value:
description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID?overrideTargetId=domainUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1523597066886.0
name: KeyChainObjectName1
overridable: true
overrides:
parent:
id: KeyChainUUID
type: KeyChainObject
target:
id: domainUUID
name: Global \ ASIA \ INDIA
type: Domain
type: KeyChainObject
schema:
$ref: '#/components/schemas/KeyChainObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the keychain object associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateKeyChainObject
parameters:
- description: Unique identifier of the keychain object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID ( PUT method for Key Chain Object )':
value:
description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
name: KeyChainObjectName1
overridable: false
type: KeyChainObject
? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID ( PUT method for Key Chain
Object with override on domain )'
: value:
description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
name: KeyChainObjectName1
overridable: true
overrides:
parent:
id: KeyChainUUID
type: KeyChainObject
target:
id: domainUUID
name: Global \ ASIA \ INDIA
type: Domain
type: KeyChainObject
? 'Example 3 : PUT /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID ( PUT method for Key Chain
Object with override on device )'
: value:
description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
name: KeyChainObjectName1
overridable: true
overrides:
parent:
id: KeyChainUUID
type: KeyChainObject
target:
id: deviceUUID
name: 10.10.9.20
type: Device
type: KeyChainObject
schema:
$ref: '#/components/schemas/KeyChainObject'
type: object
description: Input representation of KeyChain object.
required: true
responses:
'200':
content:
application/json:
examples:
'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID ( PUT method for Key Chain Object )':
value:
description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 0
name: KeyChainObjectName1
overridable: false
type: KeyChainObject
? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID ( PUT method for Key
Chain Object with override on domain )'
: value:
description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 0
name: KeyChainObjectName1
overridable: true
overrides:
parent:
id: KeyChainUUID
type: KeyChainObject
target:
id: domainUUID
name: Global \ ASIA \ INDIA
type: Domain
type: KeyChainObject
? 'Example 3 : PUT /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID ( PUT method for Key
Chain Object with override on device )'
: value:
description: description for keychain object
id: KeyChainUUID
keys:
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 1
sendLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
- acceptLifeTime:
endLifeTimeValue: 2018-08-27 12:14:23
endLifetimeType: DATETIME
startLifeTimeValue: 2018-08-25 12:14:23
authAlgorithm: md5
authString:
cryptoEncryptionType: PLAINTEXT
cryptoKeyString: keyString
keyId: 2
sendLifeTime:
endLifeTimeValue: '234'
endLifetimeType: DURATION
startLifeTimeValue: 2018-08-25 12:14:23
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 0
name: KeyChainObjectName1
overridable: true
overrides:
parent:
id: KeyChainUUID
type: KeyChainObject
target:
id: deviceUUID
name: 10.10.9.20
type: Device
type: KeyChainObject
schema:
$ref: '#/components/schemas/KeyChainObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/localrealmusers:
get:
deprecated: false
description: '**Get the list of all local realm users.**'
operationId: getAllLocalRealmUser
parameters:
- description: To filter users by realm, use realm:{realmUUID}
To filter users by name, use name:{name}
in: query
name: filter
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/localrealmusers?limit=2 ( Get all paginated LocalRealmUsers
with limit set 2 )'
: value:
items:
- id: Local-Realm-User-UUID-1
links:
self: /fmc_config/v1/domain/default/object/localrealmusers/Local-Realm-User-UUID-1
name: Test1
type: LocalRealmUser
- id: Local-Realm-User-UUID-2
links:
self: /fmc_config/v1/domain/default/object/localrealmusers/Local-Realm-User-UUID-2
name: Test2
type: LocalRealmUser
links:
self: /fmc_config/v1/domain/domainUUID/object/localrealmusers?offset=0&limit=2
paging:
count: 5
limit: 2
next:
- /fmc_config/v1/domain/domainUUID/object/localrealmusers?offset=2&limit=2
- /fmc_config/v1/domain/domainUUID/object/localrealmusers?offset=4&limit=1
offset: 0
pages: 3
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/localrealmusers?limit=2&expanded=true ( Get all
paginated LocalRealmUser with expanded=true )'
: value:
items:
- id: Local-Realm-User-UUID-1
links:
self: /fmc_config/v1/domain/default/object/localrealmusers/Local-Realm-User-UUID-1
metadata:
domain:
id: domainUUID
name: Global
type: domain
lastUser:
id: User-UUID
name: admin
type: user
readOnly:
state: true
timestamp: 1459973987.0
name: Test1
password: '**********'
realm:
id: realmUUID
name: ntd-test.cisco.com
type: Realm
type: LocalRealmUser
- id: Local-Realm-User-UUID-2
links:
self: /fmc_config/v1/domain/default/object/localrealmusers/Local-Realm-User-UUID-2
metadata:
domain:
id: domainUUID
name: Global
type: domain
lastUser:
id: User-UUID
name: admin
type: user
readOnly:
state: true
timestamp: 1459973987.0
name: Test2
password: '**********'
realm:
id: realmUUID
name: ntd-test.cisco.com
type: Realm
type: LocalRealmUser
links:
self: /fmc_config/v1/domain/domainUUID/object/localrealmusers?offset=0&limit=2&expanded=true
paging:
count: 5
limit: 2
next:
- /fmc_config/v1/domain/domainUUID/object/localrealmusers?offset=2&limit=2
- /fmc_config/v1/domain/domainUUID/object/localrealmusers?offset=4&limit=1
offset: 0
pages: 3
schema:
$ref: '#/components/schemas/LocalRealmUserListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a local realm user. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleLocalRealmUser
parameters:
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LocalRealmUser'
type: object
description: Input representation of Local Realm User Object.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LocalRealmUser'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/localrealmusers/{objectId}:
delete:
deprecated: false
description: '**Delete the local realm user associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteLocalRealmUser
parameters:
- description: Unique identifier of the local realm user.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LocalRealmUser'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the local realm user associated with the specified ID.**'
operationId: getLocalRealmUser
parameters:
- description: Unique identifier of the local realm user.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/localrealmusers/Local-Realm-User-UUID-1 ( Get LocalRealmUser
by id )'
: value:
id: Local-Realm-User-UUID-1
metadata:
domain:
id: domainUUID
name: Global
type: Domain
lastUser:
id: User-UUID
name: admin
type: User
readOnly:
state: false
timestamp: 1459973987.0
name: Test1
password: '**********'
realm:
id: realmUUID
name: ntd-test.cisco.com
type: Realm
type: LocalRealmUser
schema:
$ref: '#/components/schemas/LocalRealmUser'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the local realm user associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateLocalRealmUser
parameters:
- description: Unique identifier of the local realm user.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/localrealmusers/Local-Realm-User-UUID-1 ( Test PUT
of LocalRealmUser )'
: value:
id: Local-Realm-User-UUID-1
name: Test1
password: TESTPASSWORD_UPDATE
realm:
id: realmUUID
name: ntd-test.cisco.com
type: Realm
type: LocalRealmUser
schema:
$ref: '#/components/schemas/LocalRealmUser'
type: object
description: Input representation of Local Realm User Object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/localrealmusers/Local-Realm-User-UUID-1 ( Test
PUT of LocalRealmUser )'
: value:
id: Local-Realm-User-UUID-1
metadata:
domain:
id: domainUUID
name: Global
type: Domain
lastUser:
id: User-UUID
name: admin
type: User
readOnly:
state: false
timestamp: 1459975244.0
name: Test1
password: '**********'
realm:
id: realmUUID
name: ntd-test.cisco.com
type: Realm
type: LocalRealmUser
schema:
$ref: '#/components/schemas/LocalRealmUser'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/macaddresspools:
get:
deprecated: false
description: '**Get the list of all MAC address pools.**'
operationId: getAllMacAddressPool
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/macaddresspools?limit=2&expanded=false ( Get all
paginated MacAddressPool objects with limit set 2 and expanded is set to flase )'
: value:
items:
- id: macaddresspool-1UUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/macaddresspools/macaddresspoolUUID
name: macaddresspool-1
type: MacAddressPool
- id: macaddresspool-2UUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/macaddresspools/macaddresspoolUUID
name: macaddresspool-2
type: MacAddressPool
links:
self: /fmc_config/v1/domain/DomainUUID/object/macaddresspools?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/macaddresspools?limit=2&expanded=true ( Get all
paginated MacAddressPool objects with limit set 2 and expanded is set to true )'
: value:
items:
- description: MacAddressPool object description
id: macaddresspool-1UUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/macaddresspools/macaddresspoolUUID
macAddressRange: aaaa.bbbb.1130-aaaa.bbbb.1140
metadata:
domain:
id: domainUUID
name: Global \ INDIA
type: Domain
lastUser:
name: user1
timestamp: number
name: macaddresspool-1
overridable: true
type: MacAddressPool
- description: MacAddressPool object description
id: macaddresspool-2UUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/macaddresspools/macaddresspoolUUID
macAddressRange: aaaa.bbbb.1150-aaaa.bbbb.1160
metadata:
domain:
id: domainUUID
name: Global \ INDIA \ Chennai
type: Domain
lastUser:
name: user1
timestamp: number
name: macaddresspool-2
overridable: true
type: MacAddressPool
links:
self: /fmc_config/v1/domain/DomainUUID/object/macaddresspools?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/MacAddressPoolListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a MAC address pool. _Check the response section for applicable examples (if any)._**'
operationId: createMacAddressPool
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/macaddresspools/ ( POST a MacAddressPool. )':
value:
description: ' '
macAddressRange: aaaa.bbbb.1130-aaaa.bbbb.1140
name: macaddresspool-1
overridable: true
type: MacAddressPool
schema:
$ref: '#/components/schemas/MacAddressPool'
type: object
description: The input Mac Address Pool object model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/MacAddressPool'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/macaddresspools/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all overrides on a MAC address pool. Response will always be in expanded form. If passed, the "expanded"
query parameter will be ignored.**'
operationId: getMacAddressPoolOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/macaddresspools/macaddresspoolUUID/overrides (
Get all overrides on given MacAddressPool objects )'
: value:
items:
- description: MacAddressPool object description
id: macaddresspool_1UUID
links:
self: /fmc_config/v1/domain/domainUUID/object/macaddresspools/macaddresspoolUUID?overrideTargetId=targetUUID
macAddressRange: aaaa.bbbb.1150-aaaa.bbbb.1160
metadata:
domain:
id: domainUUID
name: Global \ INDIA \ BENGALURU
lastUser:
name: user1
timestamp: number
name: macaddresspool-1
overridable: true
overrides:
parent:
id: macaddresspoolUUID
type: MacAddressPool
target:
id: targetUUID
name: 10.10.19.27
type: Device
type: MacAddressPool
links:
self: /fmc_config/v1/domain/domainUUID/object/macaddresspools/macaddresspoolUUID/overrides?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/MacAddressPoolOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/macaddresspools/{objectId}:
delete:
deprecated: false
description: '**Delete the MAC address pool associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteMacAddressPool
parameters:
- description: Unique identifier of the MAC address pool.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/macaddresspools/macaddresspoolUUID ( Delete
a MacAddressPool Object for the given UUID. )'
: value:
description: ' '
id: macaddresspoolUUID
links:
parent: /fmc_config/v1/domain/default/object/
self: /fmc_config/v1/domain/DomainUUID/object/macaddresspools/macaddresspoolUUID
macAddressRange: aaaa.bbbb.1130-aaaa.bbbb.1140
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: 1613995959773.0
name: macaddresspool-1
overridable: true
type: MacAddressPool
schema:
$ref: '#/components/schemas/MacAddressPool'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the MAC address pool associated with the specified ID.**'
operationId: getMacAddressPool
parameters:
- description: Unique identifier of the MAC address pool.
in: path
name: objectId
required: true
schema:
type: string
- description: Get the overrides associated with the specified MAC address pool.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/macaddresspools/macaddresspoolUUID ( Get MacAddressPool
object by id )'
: value:
description: MacAddressPool object description
id: macaddresspool-1UUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/macaddresspools/macaddresspoolUUID
macAddressRange: aaaa.bbbb.1130-aaaa.bbbb.1140
metadata:
domain:
id: domainUUID
name: Global
type: Domain
lastUser:
name: admin
timestamp: number
name: macaddresspool-1
overridable: true
type: MacAddressPool
schema:
$ref: '#/components/schemas/MacAddressPool'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the MAC address pool associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateMacAddressPool
parameters:
- description: Unique identifier of the MAC address pool.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/macaddresspools/macaddresspoolUUID ( PUT a MacAddressPool. )':
value:
description: ' '
id: 00505686-154A-0ed3-0000-008589935142
macAddressRange: aaaa.bbbb.1130-aaaa.bbbb.1140
name: macaddresspool-1
overridable: true
type: MacAddressPool
schema:
$ref: '#/components/schemas/MacAddressPool'
type: object
description: The input Mac Address Pool object model.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MacAddressPool'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/networkaddresses:
get:
deprecated: false
description: '**Get the list of all types of network objects including Network, Host, Range, and FQDN.**'
operationId: getNetworkAddress
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value and "type:{subType}" to search for specific subType of the network
object. "type:{FQDN,RANGE,HOST,NETWORK}" is for include and "type!{FQDN,RANGE,HOST,NETWORK}"
is for exclude. To search for wildcard object type:NETWORK;includeWildcard:true.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/networkaddresses ( GET ALL NetworkAddresses )':
value:
items:
- id: Network-UUID-1
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-1
name: any
type: Network
- id: Network-UUID-2
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-2
name: any-ipv4
type: Network
- id: Host-UUID-1
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-1
name: any-ipv6
type: Host
- id: Network-UUID-3
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses//Network-UUID-3
name: IPv4-Benchmark-Tests
type: Network
- id: Network-UUID-4
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-4
name: IPv4-Link-Local
type: Network
- id: Network-UUID-5
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-5
name: IPv4-Multicast
type: Network
- id: Network-UUID-6
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-6
name: IPv4-Private-10.0.0.0-8
type: Network
- id: Network-UUID-7
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-7
name: IPv4-Private-172.16.0.0-12
type: Network
- id: Network-UUID-8
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-8
name: IPv4-Private-192.168.0.0-16
type: Network
- id: Network-UUID-9
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-9
name: IPv6-IPv4-Mapped
type: Network
- id: Network-UUID-10
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-10
name: IPv6-Link-Local
type: Network
- id: Network-UUID-11
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-11
name: IPv6-Private-Unique-Local-Addresses
type: Network
- id: Network-UUID-12
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-12
name: IPv6-to-IPv4-Relay-Anycast
type: Network
- id: Network-UUID-13
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-13
name: NewTest
type: Network
- id: Network-UUID-14
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-14
name: TestGlobal
type: Network
- id: Host-UUID-2
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-2
name: TestHost
type: Host
- id: Host-UUID-3
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-3
name: TestHost1
type: Host
- id: Host-UUID-4
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-4
name: TestHostTestDomain
type: Host
- id: Host-UUID-5
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-5
name: TestTestDomain
type: Network
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses?offset=0&limit=19
paging:
count: 19
limit: 19
offset: 0
pages: 1
'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/networkaddresses?expanded=true ( GET ALL NetworkAddresses )':
value:
items:
- description: ' '
id: Network-UUID-1
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-1
metadata:
domain:
id: Global-domain-UUID
name: Global
lastUser:
name: testuser
readOnly:
reason: SYSTEM
state: true
name: any
overridable: false
type: Network
- description: ' '
id: Network-UUID-2
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-2
metadata:
domain:
id: Global-domain-UUID
name: Global
lastUser:
name: testuser
readOnly:
reason: SYSTEM
state: true
name: any-ipv4
overridable: false
type: Network
- description: ' '
id: Host-UUID-1
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-1
metadata:
domain:
id: Global-domain-UUID
name: Global
lastUser:
name: testuser
readOnly:
reason: SYSTEM
state: true
name: any-ipv6
overridable: false
type: Host
- description: ' '
id: Network-UUID-3
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-3
metadata:
domain:
id: Global-domain-UUID
name: Global
lastUser:
name: testuser
readOnly:
reason: SYSTEM
state: true
name: IPv4-Benchmark-Tests
overridable: false
type: Network
- description: ' '
id: Network-UUID-4
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-4
metadata:
domain:
id: Global-domain-UUID
name: Global
lastUser:
name: testuser
readOnly:
reason: SYSTEM
state: true
name: IPv4-Link-Local
overridable: false
type: Network
- description: ' '
id: Network-UUID-5
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-5
metadata:
domain:
id: Global-domain-UUID
name: Global
lastUser:
name: testuser
readOnly:
reason: SYSTEM
state: true
name: IPv4-Multicast
overridable: false
type: Network
- description: ' '
id: Network-UUID-6
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-6
metadata:
domain:
id: Global-domain-UUID
name: Global
lastUser:
name: testuser
readOnly:
reason: SYSTEM
state: true
name: IPv4-Private-10.0.0.0-8
overridable: false
type: Network
- description: ' '
id: Network-UUID-7
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-7
metadata:
domain:
id: Global-domain-UUID
name: Global
lastUser:
name: testuser
readOnly:
reason: SYSTEM
state: true
name: IPv4-Private-172.16.0.0-12
overridable: false
type: Network
- description: ' '
id: Network-UUID-8
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-8
metadata:
domain:
id: Global-domain-UUID
name: Global
lastUser:
name: testuser
readOnly:
reason: SYSTEM
state: true
name: IPv4-Private-192.168.0.0-16
overridable: false
type: Network
- description: ' '
id: Network-UUID-9
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-9
metadata:
domain:
id: Global-domain-UUID
name: Global
lastUser:
name: testuser
readOnly:
reason: SYSTEM
state: true
name: IPv6-IPv4-Mapped
overridable: false
type: Network
- description: ' '
id: Network-UUID-10
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-10
metadata:
domain:
id: Global-domain-UUID
name: Global
lastUser:
name: testuser
readOnly:
reason: SYSTEM
state: true
name: IPv6-Link-Local
overridable: false
type: Network
- description: ' '
id: Network-UUID-11
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-11
metadata:
domain:
id: Global-domain-UUID
name: Global
lastUser:
name: testuser
readOnly:
reason: SYSTEM
state: true
name: IPv6-Private-Unique-Local-Addresses
overridable: false
type: Network
- description: ' '
id: Network-UUID-12
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-12
metadata:
domain:
id: Global-domain-UUID
name: Global
lastUser:
name: testuser
readOnly:
reason: SYSTEM
state: true
name: IPv6-to-IPv4-Relay-Anycast
overridable: false
type: Network
- description: Test New
id: Network-UUID-13
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-13
metadata:
domain:
id: domainUUID
name: Global \ TestDomain
lastUser:
name: testuser
name: NewTest
overridable: false
type: Network
- description: TestGlobal
id: Network-UUID-14
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-14
metadata:
domain:
id: Global-domain-UUID
name: Global
lastUser:
name: testuser
name: TestGlobal
overridable: false
type: Network
- description: ' '
id: Host-UUID-2
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-2
metadata:
domain:
id: domainUUID
name: Global \ TestDomain
lastUser:
name: testuser
name: TestHost
overridable: false
type: Host
- description: ' '
id: Host-UUID-3
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-3
metadata:
domain:
id: domainUUID
name: Global \ TestDomain
lastUser:
name: testuser
name: TestHost1
overridable: false
type: Host
- description: ' '
id: Host-UUID-4
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-4
metadata:
domain:
id: domainUUID
name: Global \ TestDomain
lastUser:
name: testuser
name: TestHostTestDomain
overridable: false
type: Host
- description: TestTestDomain
id: Host-UUID-5
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-5
metadata:
domain:
id: domainUUID
name: Global \ TestDomain
lastUser:
name: testuser
name: TestTestDomain
overridable: false
type: Network
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses?offset=0&limit=19
paging:
count: 19
limit: 19
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/NetworkAddressListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/networkaddressoverrides:
get:
deprecated: false
description: '**Get overrides for all types of network objects including Network, Host, Range, and FQDN.**'
operationId: getNetworkAddressOverrides
parameters:
- description: Type of network object selected. Possible values are Host, Network, Range, and FQDN.
in: query
name: networkType
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkAddressOverridesListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/networkgroups:
delete:
deprecated: false
description: '**Delete all network groups. Use filtering to specify which network groups will be deleted. _Check the
response section for applicable examples (if any)._**'
operationId: deleteMultipleNetworkGroup
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value."ids:id1,id2,...".
ids is a comma-separated list
of rule IDs to be deleted.
in: query
name: filter
required: false
schema:
type: string
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: true
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/networkgroups/networkGroupUUID ( Test DELETE
of NetworkGroup Object )'
: value:
id: networkGroup1UUID
links:
self: /fmc_config/v1/domain/global/object/networkgroups/networkGroupUUID
literals:
- type: Network
value: 1.2.3.0/24
- type: Host
value: 1.2.3.4
metadata:
domain:
id: GlobalDomainUUID
name: Global
lastUser:
name: admin
name: networkgroup_obj1
objects:
- id: NetworkObjectUUID
links:
self: link_to_network_obj
name: network_obj_name
type: Network
- id: HostObjectUUID
links:
self: link_to_host_obj
name: host_obj_name
type: Host
- id: RangeObjectUUID
links:
self: link_to_range_obj
name: range_obj_name
type: Range
type: NetworkGroup
? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/networkgroups/netgrp2_uuid?overrideTargetId=target_uuid
( DELETE request to remove an override on network group )'
: value:
description: ' '
id: netgrp2_uuid
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networkgroups/netgrp2_uuid?overrideTargetId=target_uuid
literals:
- type: Network
value: 1.2.3.0/24
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
timestamp: 1527349890836.0
name: netgrp2
objects:
- id: fqdn1_uuid
name: fqdn1
type: FQDN
- id: net1_uuid
name: net1
type: Network
overridable: true
overrides:
parent:
id: netgrp2_uuid
type: NetworkGroup
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: NetworkGroup
schema:
$ref: '#/components/schemas/NetworkGroup'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the list of all network groups.**'
operationId: getAllNetworkGroup
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value."ids:id1,id2,...".
ids is a comma-separated list
of rule IDs to be deleted.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkGroupListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a network group. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleNetworkGroup
parameters:
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/networkgroups ( Test registration of NetworkGroup
to create a new record )'
: value:
literals:
- type: Network
value: 1.2.3.0/24
- type: Host
value: 1.2.3.4
name: networkgroup_obj1
objects:
- id: NetworkObjectUUID
type: Network
- id: HostObjectUUID
type: Host
- id: RangeObjectUUID
type: Range
type: NetworkGroup
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/networkgroups?bulk=true ( Bulk POST operation for
network groups )'
: value:
- literals:
- type: Host
value: 1.2.3.4
name: ng1
objects:
- id: f0ce41ae-6ee9-4e00-8762-da9370c4fee5
name: IPv4-Link-Local
type: Network
type: NetworkGroup
- literals:
- type: Network
value: 1.2.3.0/24
name: ng2
objects:
- id: 00000000-0000-0ed3-0000-103079215282
name: Range1
type: Range
type: NetworkGroup
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/networkgroups?bulk=true ( Bulk POST operation for
network groups with overrides )'
: value:
- description: ' '
id: netgrp_uuid
literals:
- type: Host
value: 1.2.3.10
name: netgrp
objects:
- id: fqdn_obj_uuid
name: fqdn_obj
type: FQDN
- id: net_1_uuid
name: net_1
type: Network
overridable: true
overrides:
parent:
id: netgrp_uuid
type: NetworkGroup
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: NetworkGroup
- description: ' '
id: netgrp_uuid
literals:
- type: Host
value: 1.2.3.20
name: netgrp
objects:
- id: host_10_uuid
name: host_10
type: Host
- id: net_1_uuid
name: net_1
type: Network
overridable: true
overrides:
parent:
id: netgrp_uuid
type: NetworkGroup
target:
id: device_uuid
name: FTDv_R1
type: Device
type: NetworkGroup
? 'Example 4 : POST /fmc_config/v1/domain/domainUuid/object/networkgroups ( POST request to create an override
on network group )'
: value:
description: ' '
id: netgrp2_uuid
name: netgrp2
objects:
- id: fqdn1_uuid
name: fqdn1
type: FQDN
- id: net1_uuid
name: net1
type: Network
overridable: true
overrides:
parent:
id: netgrp2_uuid
type: NetworkGroup
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: NetworkGroup
? 'Example 5 : POST /fmc_config/v1/domain/DomainUUID/object/networkgroups ( Test POST of network group object
to create a new record )'
: value:
literals:
- type: Network
value: 10.0.0.0/8
- type: Host
value: 10.0.0.25
name: network_group_1
objects:
- id: networkGroupUUID
name: network_group_object_4
type: Network
- id: networkGroupUUID
name: network_group_object_3
type: Network
type: Network
schema:
$ref: '#/components/schemas/NetworkGroup'
type: object
description: Input representation of network group.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/networkgroups?bulk=true ( Bulk POST operation
for network groups )'
: value:
items:
- description: ' '
id: ng1Uuid
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networkgroups/ng1Uuid
literals:
- type: Host
value: 1.2.3.4
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: pvs
timestamp: 0
name: ng1
objects:
- id: net1Uuid
name: net1
type: Network
overridable: false
type: NetworkGroup
- description: ' '
id: ng2Uuid
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networkgroups/ng2Uuid
literals:
- type: Network
value: 1.2.3.0/24
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: pvs
timestamp: 0
name: ng2
objects:
- id: range1Uuid
name: Range1
type: Range
overridable: false
type: NetworkGroup
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networkgroups?bulk=true
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/networkgroups?bulk=true ( Bulk POST operation
for network groups with overrides )'
: value:
items:
- id: netgrp_uuid
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networkgroups/netgrp_uuid
literals:
- type: Host
value: 1.2.3.10
metadata:
domain:
id: domain_uuid
name: Global \ EUROPE
lastUser:
name: pvs
timestamp: 0
name: netgrp
objects:
- id: fqdn_obj_uuid
name: fqdn_obj
type: FQDN
- id: net_1_uuid
name: net_1
type: Network
overridable: true
overrides:
parent:
id: netgrp_uuid
type: NetworkGroup
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: NetworkGroup
- id: netgrp_uuid
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networkgroups/netgrp_uuid
literals:
- type: Host
value: 1.2.3.20
metadata:
domain:
id: domain_uuid
name: Global \ ASIA
lastUser:
name: pvs
timestamp: 0
name: netgrp
objects:
- id: host_10_uuid
name: host_10
type: Host
- id: net_1_uuid
name: net_1
type: Network
overridable: true
overrides:
parent:
id: netgrp_uuid
type: NetworkGroup
target:
id: device_uuid
name: FTDv_R1
type: Device
type: NetworkGroup
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networkgroups?bulk=true
? 'Example 4 : POST /fmc_config/v1/domain/domainUuid/object/networkgroups ( POST request to create an override
on network group )'
: value:
id: netgrp2_uuid
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networkgroups/netgrp2_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
timestamp: 0
name: netgrp2
objects:
- id: fqdn1_uuid
name: fqdn1
type: FQDN
- id: net1_uuid
name: net1
type: Network
overridable: true
overrides:
parent:
id: netgrp2_uuid
type: NetworkGroup
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: NetworkGroup
schema:
$ref: '#/components/schemas/NetworkGroup'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/networkgroups/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all overrides on a network group. Response will always be in expanded form. If passed, the "expanded"
query parameter will be ignored.**'
operationId: getAllNetworkGroupOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/networkgroups/networkGroupUUID/overrides ( Get
all overrides on Given NetworkGroup object )'
: value:
items:
- description: ' '
id: networkGroupUUID
links:
self: /fmc_config/v1/domain/domainUUID/object/networkgroups/networkGroupUUID?overrideTargetId=targetUUID
metadata:
domain:
id: targetUUID
name: Global \ INDIA \ BENGALURU
lastUser:
name: user1
timestamp: 1520419016850.0
name: NW_Group
objects:
- id: networkUUID
name: IPv4-Link-Local
type: Network
overridable: true
overrides:
parent:
id: networkGroupUUID
type: NetworkGroup
target:
id: targetUUID
name: Global \ INDIA \ BENGALURU
type: Domain
type: NetworkGroup
links:
self: /fmc_config/v1/domain/domainUUID/object/networkgroups/networkGroupUUID/overrides?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/NetworkGroupOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/networkgroups/{containerUUID}/overrides/{objectId}:
get:
deprecated: false
description: '**Get the specified override of network group override object. Response will always be in expanded form.
If passed, the "expanded" query parameter will be ignored.**'
operationId: getNetworkGroupOverride
parameters:
- description: Unique identifier of the network group override object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkGroupOverride'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/networkgroups/{objectId}:
delete:
deprecated: false
description: '**Delete the network group associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteNetworkGroup
parameters:
- description: Unique identifier of the network group.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/networkgroups/networkGroupUUID ( Test DELETE
of NetworkGroup Object )'
: value:
id: networkGroup1UUID
links:
self: /fmc_config/v1/domain/global/object/networkgroups/networkGroupUUID
literals:
- type: Network
value: 1.2.3.0/24
- type: Host
value: 1.2.3.4
metadata:
domain:
id: GlobalDomainUUID
name: Global
lastUser:
name: admin
name: networkgroup_obj1
objects:
- id: NetworkObjectUUID
links:
self: link_to_network_obj
name: network_obj_name
type: Network
- id: HostObjectUUID
links:
self: link_to_host_obj
name: host_obj_name
type: Host
- id: RangeObjectUUID
links:
self: link_to_range_obj
name: range_obj_name
type: Range
type: NetworkGroup
? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/networkgroups/netgrp2_uuid?overrideTargetId=target_uuid
( DELETE request to remove an override on network group )'
: value:
description: ' '
id: netgrp2_uuid
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networkgroups/netgrp2_uuid?overrideTargetId=target_uuid
literals:
- type: Network
value: 1.2.3.0/24
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
timestamp: 1527349890836.0
name: netgrp2
objects:
- id: fqdn1_uuid
name: fqdn1
type: FQDN
- id: net1_uuid
name: net1
type: Network
overridable: true
overrides:
parent:
id: netgrp2_uuid
type: NetworkGroup
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: NetworkGroup
schema:
$ref: '#/components/schemas/NetworkGroup'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the network group associated with the specified ID.**'
operationId: getNetworkGroup
parameters:
- description: Unique identifier of the network group.
in: path
name: objectId
required: true
schema:
type: string
- description: Get the overrides associated with the specified network group.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/networkgroups/networkGroup1UUID ( Test GET of NetworkGroup
Object for a uuid )'
: value:
id: networkGroup1UUID
links:
self: /fmc_config/v1/domain/global/object/networkgroups/networkGroupUUID
literals:
- type: Network
value: 1.2.3.0/24
- type: Host
value: 1.2.3.4
metadata:
domain:
id: GlobalDomainUUID
name: Global
lastUser:
name: admin
name: networkgroup_obj1
objects:
- id: NetworkObjectUUID
links:
self: link_to_network_obj
name: network_obj_name
type: Network
- id: HostObjectUUID
links:
self: link_to_host_obj
name: host_obj_name
type: Host
- id: RangeObjectUUID
links:
self: link_to_range_obj
name: range_obj_name
type: Range
type: NetworkGroup
'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/networkgroups ( Test GET listing of NetworkGroups )':
value:
items:
- id: networkGroup1UUID
links:
self: /fmc_config/v1/domain/global/object/networkgroups/networkGroup1UUID
name: networkgroup_obj1_name
type: NetworkGroup
- id: networkGroup2UUID
links:
self: /fmc_config/v1/domain/global/object/networkgroups/networkGroup2UUID
name: networkgroup_obj2_name
type: NetworkGroup
- id: networkGroup3UUID
links:
self: /fmc_config/v1/domain/global/object/networkgroups/networkGroup3UUID
name: networkgroup_obj3_name
type: NetworkGroup
links:
self: /fmc_config/v1/domain/global/object/networkgroups?offset=0&limit=3
paging:
count: 3
limit: 3
offset: 0
pages: 1
? 'Example 3 : GET /fmc_config/v1/domain/DomainUUID/object/networkgroups?overrideTargetId=target_uuid&expanded=true
( GET operation for network groups with overrides )'
: value:
items:
- description: ' '
id: grp2_uuid
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networkgroups/grp2_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domain_uuid
name: Global \ ASIA \ INDIA
lastUser:
name: pvs
timestamp: 1528178460773.0
name: grp2
objects:
- id: fqdn1_uuid
name: fqdn1
type: FQDN
overridable: true
overrides:
parent:
id: grp2_uuid
type: NetworkGroup
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: NetworkGroup
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networkgroups?offset=0&limit=1&overrideTargetId=target_uuid&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/NetworkGroup'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the network group associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateNetworkGroup
parameters:
- description: Unique identifier of the network group.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: Indicates whether the network objects will be added or removed from the network group. Possible values
are *add* and *remove*.
in: query
name: action
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/networkgroups/networkGroup1UUID ( Test PUT of NetworkGroup
object to update record )'
: value:
id: networkGroup1UUID
literals:
- type: Network
value: 1.2.3.0/24
- type: Host
value: 1.2.3.4
name: networkgroup_obj1_updated
objects:
- id: NetworkObjectUUID
type: Network
- id: HostObjectUUID
type: Host
- id: RangeObjectUUID
type: Range
type: NetworkGroup
? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/networkgroups/netgrp2_uuid ( PUT request to update
an override on a network group )'
: value:
description: ' '
id: netgrp2_uuid
literals:
- type: Network
value: 1.2.3.0/24
- type: Host
value: 1.2.3.4
name: netgrp2
objects:
- id: fqdn1_uuid
name: fqdn1
type: FQDN
- id: net1_uuid
name: net1
type: Network
overridable: true
overrides:
parent:
id: netgrp2_uuid
type: NetworkGroup
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: NetworkGroup
? 'Example 3 : PUT /fmc_config/v1/domain/DomainUUID/object/networkgroups/netgrp2_uuid?action=add ( PUT request
to add objects or literals on a network group )'
: value:
id: netgrp2_uuid
literals:
- type: Network
value: 1.2.3.0/24
- type: Host
value: 1.2.3.4
objects:
- id: net1_uuid
name: net1
type: Network
type: NetworkGroup
? 'Example 4 : PUT /fmc_config/v1/domain/DomainUUID/object/networkgroups/netgrp2_uuid?action=remove ( PUT request
to remove objects or literals on a network group )'
: value:
id: netgrp2_uuid
literals:
- type: Network
value: 1.2.3.0/24
- type: Host
value: 1.2.3.4
objects:
- id: net1_uuid
name: net1
type: Network
type: NetworkGroup
schema:
$ref: '#/components/schemas/NetworkGroup'
type: object
description: Input representation of network group.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/networkgroups/networkGroup1UUID ( Test PUT of NetworkGroup
object to update record )'
: value:
description: ' '
id: networkGroup1UUID
links:
self: /fmc_config/v1/domain/global/object/networkgroups/networkGroup1UUID
literals:
- type: Host
value: 1.2.3.4
- type: Network
value: 1.2.3.0/24
metadata:
domain:
id: global_uuid
name: Global
lastUser:
name: pvs
name: networkgroup_obj1_updated
objects:
- id: host_obj_id
name: host_obj_name
overridable: false
type: Host
- id: range_obj_id
name: range_obj_name
overridable: false
type: Range
- id: net_obj_id
name: net_obj_name
overridable: false
type: Network
overridable: false
type: NetworkGroup
? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/networkgroups/netgrp2_uuid ( PUT request to update
an override on a network group )'
: value:
id: netgrp2_uuid
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networkgroups/netgrp2_uuid?overrideTargetId=target_uuid
literals:
- type: Network
value: 1.2.3.0/24
- type: Host
value: 1.2.3.4
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
timestamp: 0
name: netgrp2
objects:
- id: fqdn1_uuid
name: fqdn1
type: FQDN
- id: net1_uuid
name: net1
type: Network
overridable: true
overrides:
parent:
id: netgrp2_uuid
type: NetworkGroup
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: NetworkGroup
? 'Example 3 : PUT /fmc_config/v1/domain/DomainUUID/object/networkgroups/netgrp2_uuid?action=add ( PUT request
to add objects or literals on a network group )'
: value:
id: netgrp2_uuid
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networkgroups/netgrp2_uuid
literals:
- type: Host
value: 1.1.1.1
- type: Network
value: 1.2.3.0/24
- type: Host
value: 1.2.3.4
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
timestamp: 0
name: netgrp2
objects:
- id: net_uuid
name: net
type: Network
- id: net1_uuid
name: net1
type: Network
overridable: false
type: NetworkGroup
? 'Example 4 : PUT /fmc_config/v1/domain/DomainUUID/object/networkgroups/netgrp2_uuid?action=remove ( PUT
request to remove objects or literals on a network group )'
: value:
id: netgrp2_uuid
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networkgroups/netgrp2_uuid
literals:
- type: Host
value: 1.1.1.1
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
timestamp: 0
name: netgrp2
objects:
- id: net_uuid
name: net
type: Network
overridable: false
type: NetworkGroup
schema:
$ref: '#/components/schemas/NetworkGroup'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/networks:
delete:
deprecated: false
description: '**Delete all network objects. Use filtering to specify which network objects will be deleted. _Check the
response section for applicable examples (if any)._**'
operationId: deleteMultipleNetworkObject
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
"ids:id1,id2,...".ids is a comma-separated list
of rule IDs to be deleted.
in: query
name: filter
required: false
schema:
type: string
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: true
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/object/networks/networkObjectUUID ( DELETE a network
object for the given UUID )'
: value:
description: Test Description
id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
metadata:
domain:
id: GlobalDomainUUID
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
name: network_obj_name
overridable: false
type: Network
value: 1.2.3.0/24
? 'Example 2 : DELETE /fmc_config/v1/domain/domainUUID/object/networks/net2_uuid?overrideTargetId=device_uuid
( DELETE a specific network override object )'
: value:
links:
description: ' '
id: net2_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/networks/net2_uuid?overrideTargetId=device_uuid
metadata:
domain:
id: domainUuid
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
timestamp: 1527150593963.0
name: net2
overridable: true
overrides:
parent:
id: net2_uuid
type: Network
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: Network
value: 1.2.4.0/25
schema:
$ref: '#/components/schemas/NetworkObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the list of all network objects.**'
operationId: getAllNetworkObject
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
"ids:id1,id2,...".ids is a comma-separated list
of rule IDs to be deleted.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/GlobalDomainUUID/object/networks?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET ALL method from global domain for NetworkObject when overrides are assigned to child
domain )'
: value:
items:
- description: ' '
id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
metadata:
domain:
id: subDomainUUID
name: Global \ Asia
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
name: pvs_network
overridable: true
overrides:
parent:
id: networkObjectUUID
type: Network
target:
id: subDomainUUID
name: Global \ Asia
type: Domain
type: Network
value: 1.2.3.0/24
links:
self: /fmc_config/v1/domain/global/object/networks?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/childDomainUUID/object/networks?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET ALL method from child domain for NetworkObject when overrides are assigned to child
domain )'
: value:
items:
- description: ' '
id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/subDomainUUID/object/networkaddresses
self: /fmc_config/v1/domain/subDomainUUID/object/networks/networkObjectUUID
metadata:
domain:
id: subDomainUUID
name: Global \ Asia
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
name: pvs_network
overridable: true
overrides:
parent:
id: networkObjectUUID
type: Network
target:
id: subDomainUUID
name: Global \ Asia
type: Domain
type: Network
value: 1.2.3.0/24
links:
self: /fmc_config/v1/domain/subDomainUUID/object/networks?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 3 : GET /fmc_config/v1/domain/DomainUUID/object/networks?limit=5 ( Get all paginated network objects
with limit=5 )'
: value:
items:
- id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
name: network_0
type: Network
- id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
name: network_1
type: Network
- id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
name: network_2
type: Network
- id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
name: network_3
type: Network
- id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
name: network_4
type: Network
links:
self: /fmc_config/v1/domain/DomainUUID/object/networks?offset=0&limit=5
paging:
count: 10
limit: 5
next:
- /fmc_config/v1/domain/DomainUUID/object/networks?offset=5&limit=5
offset: 0
pages: 2
? 'Example 4 : GET /fmc_config/v1/domain/DomainUUID/object/networks?expanded=false&limit=5 ( Get all paginated
network objects with limit=5 and expanded=false )'
: value:
items:
- id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
name: network_0
type: Network
- id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
name: network_1
type: Network
- id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
name: network_2
type: Network
- id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
name: network_3
type: Network
- id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
name: network_4
type: Network
links:
self: /fmc_config/v1/domain/DomainUUID/object/networks?offset=0&limit=5
paging:
count: 10
limit: 5
next:
- /fmc_config/v1/domain/DomainUUID/object/networks?offset=5&limit=5
offset: 0
pages: 2
? 'Example 5 : GET /fmc_config/v1/domain/DomainUUID/object/networks?expanded=true&limit=5 ( Get all paginated
network objects with expanded=true and limit=5 )'
: value:
items:
- name: network_0
overridable: false
type: Network
- name: network_1
overridable: false
type: Network
- name: network_2
overridable: false
type: Network
- name: network_3
overridable: false
type: Network
- name: network_4
overridable: false
type: Network
links:
self: /fmc_config/v1/domain/DomainUUID/object/networks?offset=0&limit=5
paging:
count: 10
limit: 5
next:
- /fmc_config/v1/domain/DomainUUID/object/networks?offset=5&limit=5
offset: 0
pages: 2
schema:
$ref: '#/components/schemas/NetworkObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a network object. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleNetworkObject
parameters:
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/networks?bulk=true ( Bulk POST operation on network objects. )':
value:
- description: Network obj 1
name: net1
overridable: false
type: Network
value: 1.0.0.0/24
- description: Network obj 2
name: net2
overridable: false
type: Network
value: 1.1.0.0/24
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/networks?bulk=true ( Bulk POST operation on network
objects with overrides )'
: value:
- description: ' '
id: net_1_uuid
name: net_1
overridable: true
overrides:
parent:
id: net_1_uuid
type: Network
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: Network
value: 10.10.10.0/25
- description: ' '
id: net_1_uuid
name: net_1
overridable: true
overrides:
parent:
id: net_1_uuid
type: Network
target:
id: device_uuid
name: FTDv_R1
type: Device
type: Network
value: 20.20.20.0/25
'Example 3 : POST /fmc_config/v1/domain/domainUUID/object/networks ( POST request to create a network object override )':
value:
description: ' '
id: net2_uuid
name: net2
overridable: true
overrides:
parent:
id: net2_uuid
type: Host
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: Network
value: 1.2.3.0/25
'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/networks ( Test POST of network object to create a new record )':
value:
description: Test REST API Object
name: test1
overridable: false
type: Network
value: 1.0.0.0/24
schema:
$ref: '#/components/schemas/NetworkObject'
type: object
description: Input representation of network object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/networks?bulk=true ( Bulk POST operation on network objects. )':
value:
items:
- description: Network obj 1
id: net1Uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/networks/net1Uuid
metadata:
domain:
id: domainUuid
name: Global
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
timestamp: 0
name: net1
overridable: false
type: Network
value: 1.0.0.0/24
- description: Network obj 2
id: net2Uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/networks/net2Uuid
metadata:
domain:
id: domainUuid
name: Global
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
timestamp: 0
name: net2
overridable: false
type: Network
value: 1.1.0.0/24
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networks?bulk=true
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/networks?bulk=true ( Bulk POST operation on network
objects with overrides )'
: value:
items:
- id: net_1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/networks/net_1_uuid
metadata:
domain:
id: domain_uuid
name: Global \ EUROPE
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
timestamp: 0
name: net_1
overridable: true
overrides:
parent:
id: net_1_uuid
type: Network
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: Network
value: 10.10.10.0/25
- id: net_1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/networks/net_1_uuid
metadata:
domain:
id: domainUuid
name: Global \ ASIA
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
timestamp: 0
name: net_1
overridable: true
overrides:
parent:
id: net_1_uuid
type: Network
target:
id: device_uuid
name: FTDv_R1
type: Device
type: Network
value: 20.20.20.0/25
links:
self: /api/fmc_config/v1/domain/domainUuid/object/networks?bulk=true
'Example 3 : POST /fmc_config/v1/domain/domainUUID/object/networks ( POST request to create a network object override )':
value:
id: net2_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/networks/net2_uuid?overrideTargetId=device_uuid
metadata:
domain:
id: domainUuid
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
timestamp: 0
name: net2
overridable: true
overrides:
parent:
id: net2_uuid
type: Network
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: Network
value: 1.2.3.0/25
schema:
$ref: '#/components/schemas/NetworkObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/networks/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all overrides on the specified network object. Response will always be in expanded form. If passed,
the "expanded" query parameter will be ignored.**'
operationId: getAllNetworkOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/networks/{objectId}:
delete:
deprecated: false
description: '**Delete the network object associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteNetworkObject
parameters:
- description: Unique identifier of the network object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/object/networks/networkObjectUUID ( DELETE a network
object for the given UUID )'
: value:
description: Test Description
id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
metadata:
domain:
id: GlobalDomainUUID
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
name: network_obj_name
overridable: false
type: Network
value: 1.2.3.0/24
? 'Example 2 : DELETE /fmc_config/v1/domain/domainUUID/object/networks/net2_uuid?overrideTargetId=device_uuid
( DELETE a specific network override object )'
: value:
links:
description: ' '
id: net2_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/networks/net2_uuid?overrideTargetId=device_uuid
metadata:
domain:
id: domainUuid
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
timestamp: 1527150593963.0
name: net2
overridable: true
overrides:
parent:
id: net2_uuid
type: Network
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: Network
value: 1.2.4.0/25
schema:
$ref: '#/components/schemas/NetworkObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the network object associated with the specified ID.**'
operationId: getNetworkObject
parameters:
- description: Unique identifier of the network object.
in: path
name: objectId
required: true
schema:
type: string
- description: Get the overrides associated with the specified network object.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/GlobalDomainUUID/object/networks/networkObjectUUID?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET method from global domain on a specific NetworkObject which has override assigned as
child domain )'
: value:
description: ' '
id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/hosts/networkObjectUUID
metadata:
domain:
id: subDomainUUID
name: Global \ Asia
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
name: pvs_global
overridable: true
overrides:
parent:
id: networkObjectUUID
type: Host
target:
id: subDomainUUID
name: Global \ Asia
type: Domain
type: Host
value: 1.2.3.4
? 'Example 2 : GET /fmc_config/v1/domain/childDomainUUID/object/networks/networkObjectUUID?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET method from child domain on a NetworkObject which has child domain assigned as override
)'
: value:
description: ' '
id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
metadata:
domain:
id: subDomainUUID
name: Global \ Asia
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
name: pvs_network
overridable: true
overrides:
parent:
id: networkObjectUUID
type: Network
target:
id: subDomainUUID
name: Global \ Asia
type: Domain
type: Network
value: 1.2.3.0/24
? 'Example 3 : GET /fmc_config/v1/domain/childDomainUUID/object/networks/networkObjectUUID?expanded=true&overrideTargetId=deviceUUID
( Success: Test GET method from child domain on a NetworkObject which has device assigned as override )'
: value:
description: ' '
id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
metadata:
domain:
id: subDomainUUID
name: Global \ Asia
ipType: V_4
lastUser:
name: api
parentType: NetworkAddress
name: pvs_network
overridable: true
overrides:
parent:
id: networkObjectUUID
type: Network
target:
id: deviceUUID
name: device_name
type: Device
type: Network
value: 1.2.3.0/24
schema:
$ref: '#/components/schemas/NetworkObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the network object associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateNetworkObject
parameters:
- description: Unique identifier of the network object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/networks/networkObjectUUID ( PUT to update a network object )':
value:
description: Test Description
id: networkObjectUUID
name: network_obj_name
overridable: false
type: Network
value: 1.2.3.0/24
? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/object/networks/net2_uuid ( PUT to update override value
on a given network override object )'
: value:
description: ' '
id: net2_uuid
name: net2
overridable: true
overrides:
parent:
id: net2_uuid
type: Host
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: Network
value: 1.2.3.0/25
schema:
$ref: '#/components/schemas/NetworkObject'
type: object
description: The input network object model.
required: true
responses:
'200':
content:
application/json:
examples:
'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/networks/networkObjectUUID ( PUT to update a network object )':
value:
id: networkObjectUUID
links:
parent: /fmc_config/v1/domain/global/object/networkaddresses
self: /fmc_config/v1/domain/global/object/networks/networkObjectUUID
metadata:
domain:
id: GlobalDomainUUID
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
name: network_obj_name
overridable: false
type: Network
value: 1.2.3.0/24
? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/object/networks/net2_uuid ( PUT to update override value
on a given network override object )'
: value:
id: net2_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/networks/net2_uuid?overrideTargetId=device_uuid
metadata:
domain:
id: domainUuid
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
timestamp: 0
name: net2
overridable: true
overrides:
parent:
id: net2_uuid
type: Network
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: Network
value: 1.2.3.0/25
schema:
$ref: '#/components/schemas/NetworkObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ntpservers:
get:
deprecated: false
description: '**Get the list of all NTP servers.**'
operationId: getAllNTPServerObject
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/object/ntpservers ( Get all paginated NTP Server Objects )':
value:
items:
- authKey: '12345'
authValue: '********'
id: NTPServerUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ntpservers/NTPServerUUID
name: NTPServer1
type: NTPServer
value: 2.2.2.2
- authKey: '12345'
authValue: '********'
id: NTPServerUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ntpservers/NTPServerUUID
name: NTPServer2
value: 3.3.3.3
- authKey: ''
authValue: ''
id: NTPServerUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ntpservers/NTPServerUUID
name: NTPServer3
type: NTPServer
value: 4.4.4.4
links:
self: api/fmc_config/v1/domain/DomainUUID/object/ntpservers?offset=0&limit=3
paging:
count: 3
limit: 3
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/object/ntpservers?expanded=true ( Get all paginated
NTP Server Objects )'
: value:
items:
- authKey: '12345'
authValue: '********'
id: NTPServerUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ntpservers/NTPServerUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1524118335170.0
name: NTPServer1
type: NTPServer
value: 2.2.2.2
- authKey: '12345'
authValue: '********'
id: NTPServerUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ntpservers/NTPServerUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1523597066886.0
name: NTPServer2
type: NTPServer
value: 3.3.3.3
- authKey: '12345'
authValue: '********'
id: NTPServerUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ntpservers/NTPServerUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1524118310520.0
name: NTPServer3
type: NTPServer
value: 4.4.4.4
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ntpservers?offset=0&limit=3&expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/NTPServerObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create an NTP server. _Check the response section for applicable examples (if any)._**'
operationId: createNTPServerObject
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/ntpservers ( POST method for NTP Server Object )':
value:
authKey: '12345'
authValue: password123
name: NTPServer1
type: NTPServer
value: 2.2.2.2
schema:
$ref: '#/components/schemas/NTPServerObject'
type: object
description: Input representation of NTP Server object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/ntpservers ( POST method for NTP Server Object )':
value:
authKey: '12345'
authValue: '********'
id: NTPServerUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ntpservers/NTPServerUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 0
name: NTPServer1
type: NTPServer
value: 2.2.2.2
schema:
$ref: '#/components/schemas/NTPServerObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ntpservers/{objectId}:
delete:
deprecated: false
description: '**Delete the NTP server associated with the specified ID. _Check the response section for applicable examples
(if any)._**'
operationId: deleteNTPServerObject
parameters:
- description: Unique identifier of the NTP server.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/object/ntpservers/NTPServerUUID ( DELETE method
for NTP Server Object )'
: value:
authKey: '12345'
authValue: '********'
id: NTPServerUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ntpservers/NTPServerUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1524129145233.0
name: NTPServer1
type: NTPServer
value: 2.2.2.2
schema:
$ref: '#/components/schemas/NTPServerObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the NTP server associated with the specified ID.**'
operationId: getNTPServerObject
parameters:
- description: Unique identifier of the NTP server.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/object/ntpservers/NTPServerUUID ( Get NTP Server Object by id )':
value:
authKey: '12345'
authValue: '********'
id: NTPServerUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ntpservers/NTPServerUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1523597066886.0
name: NTPServer1
type: NTPServer
value: 2.2.2.2
schema:
$ref: '#/components/schemas/NTPServerObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the NTP server associated with the specified ID. _Check the response section for applicable examples
(if any)._**'
operationId: updateNTPServerObject
parameters:
- description: Unique identifier of the NTP server.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/object/ntpservers/NTPServerUUID ( PUT method for NTP Server Object )':
value:
authKey: '12345'
authValue: password123
id: NTPServerUUID
name: NTPServer1
type: NTPServer
value: 2.2.2.2
schema:
$ref: '#/components/schemas/NTPServerObject'
type: object
description: Input representation of NTP Server object.
required: true
responses:
'200':
content:
application/json:
examples:
'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/object/ntpservers/NTPServerUUID ( PUT method for NTP Server Object )':
value:
authKey: '12345'
authValue: '********'
id: NTPServerUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/ntpservers/NTPServerUUID
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 0
name: NTPServer1
type: NTPServer
value: 2.2.2.2
schema:
$ref: '#/components/schemas/NTPServerObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/operational/findoverlaps:
post:
deprecated: false
description: '**Get overlaps for the given network objects/literals and port objects/literals. _Check the response section
for applicable examples (if any)._**'
operationId: createOverlapWarning
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/operational/findoverlaps ( Fetch partial and full
overlaps between objects/literals for networks )'
: value:
networks:
literals:
- type: Host
value: 1.1.1.1
- type: Network
value: 1.1.1.0/24
objects:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
ports:
literals: []
objects: []
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/operational/findoverlaps ( Fetch partial and full
overlaps between objects/literals for ports )'
: value:
networks:
literals: []
objects: []
ports:
literals:
- port: '80'
protocol: '6'
type: PortLiteral
objects:
- id: 18312adc-38bb-11e2-86aa-62f0c593a59a
name: HTTP
type: ProtocolPortObject
- id: 1834bd00-38bb-11e2-86aa-62f0c593a59a
name: HTTPS
type: ProtocolPortObject
- id: 0050568A-9CA9-0ed3-0000-038654705760
name: portObj
type: ProtocolPortObject
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/operational/findoverlaps ( Fetch partial and full
overlaps between objects/literals for network and ports both )'
: value:
networks:
literals:
- type: Host
value: 1.1.1.1
- type: Network
value: 1.1.1.0/24
objects:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
ports:
literals:
- port: '80'
protocol: '6'
type: PortLiteral
objects:
- id: 18312adc-38bb-11e2-86aa-62f0c593a59a
name: HTTP
type: ProtocolPortObject
- id: 1834bd00-38bb-11e2-86aa-62f0c593a59a
name: HTTPS
type: ProtocolPortObject
schema:
$ref: '#/components/schemas/OverlapWarning'
type: object
description: Input representation of networks and ports.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/operational/findoverlaps ( Fetch partial and full
overlaps between objects/literals for networks )'
: value:
networks:
literals:
- overlappingLiterals:
- overlapType: FULL
value: 1.1.1.0/24
overlappingObjects:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
overlapType: FULL
type: Network
type: Host
value: 1.1.1.1
- overlappingObjects:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
overlapType: FULL
type: Network
type: Network
value: 1.1.1.0/24
ports: {}
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/operational/findoverlaps ( Fetch partial and full
overlaps between objects/literals for ports )'
: value:
networks: {}
ports:
literals:
- overlappingObjects:
- id: 0050568A-9CA9-0ed3-0000-038654705760
name: portObj
overlapType: FULL
type: ProtocolPortObject
port: '80'
protocol: '6'
type: PortLiteral
objects:
- id: 18312adc-38bb-11e2-86aa-62f0c593a59a
name: HTTP
overlappingLiterals:
- overlapType: FULL
port: '80'
protocol: '6'
type: PortLiteral
overlappingObjects:
- id: 0050568A-9CA9-0ed3-0000-038654705760
name: portObj
overlapType: FULL
type: ProtocolPortObject
type: ProtocolPortObject
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/operational/findoverlaps ( Fetch partial and full
overlaps between objects/literals for network and ports both )'
: value:
networks:
literals:
- overlappingLiterals:
- overlapType: FULL
value: 1.1.1.0/24
overlappingObjects:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
overlapType: FULL
type: Network
type: Host
value: 1.1.1.1
- overlappingObjects:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
overlapType: FULL
type: Network
type: Network
value: 1.1.1.0/24
ports:
objects:
- id: 18312adc-38bb-11e2-86aa-62f0c593a59a
name: HTTP
overlappingLiterals:
- overlapType: FULL
port: '80'
protocol: '6'
type: PortLiteral
type: ProtocolPortObject
schema:
$ref: '#/components/schemas/OverlapWarning'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/operational/realmstatuses:
get:
deprecated: false
description: '**Get SAML realm status information.**'
operationId: getRealmStatus
parameters:
- description: Comma-separated list of identifiers of requested SAML realms.
in: query
name: ids
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RealmStatusListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/operational/testrealms:
post:
deprecated: false
description: '**Test realm connectivity. _Check the response section for applicable examples (if any)._**'
operationId: createRealmTest
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/operational/testrealms ( Test Azure AD connector
properties with client secret value set )'
: value:
identityConnector:
clientId: 20354d7a-e4fe-47af-8ff6-187bca92f3f9
clientSecret: E-c3Q~XUeeeBdkfVBt8QdnS6TVOC2DfDI7OlK
consumerGroupId: azuread-events-test
eventHubsBroker: azure-ad-events-934j.servicebus.windows.net:9093
eventHubsConnString: Endpoint=sb://azure-ad-events-934j.servicebus.windows.net/;SharedAccessKeyName=testad;SharedAccessKey=Fq6YV/ruwOKFYiPVm6PcJKpU3R7a4OEtlfXC7djc0o4=
eventHubsTopic: test
excludedGroups:
- Group_name1
- EU_*
- '*_test'
includeGroups: []
tenantId: 8c67caeb-e5f4-4ae0-be47-fbb739939768
type: AzureADConnector
type: RealmTest
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/object/operational/testrealms ( Test Azure AD connector
properties with client secret value cached )'
: value:
identityConnector:
clientId: 20354d7a-e4fe-47af-8ff6-187bca92f3f9
clientSecret: '********'
consumerGroupId: azuread-events-test
eventHubsBroker: azure-ad-events-934j.servicebus.windows.net:9093
eventHubsConnString: Endpoint=sb://azure-ad-events-934j.servicebus.windows.net/;SharedAccessKeyName=testad;SharedAccessKey=Fq6YV/ruwOKFYiPVm6PcJKpU3R7a4OEtlfXC7djc0o4=
eventHubsTopic: test
excludedGroups:
- Group_name1
- EU_*
- '*_test'
id: azuread-meta-connector.1
includeGroups: []
tenantId: 8c67caeb-e5f4-4ae0-be47-fbb739939768
type: AzureADConnector
type: RealmTest
schema:
$ref: '#/components/schemas/RealmTest'
type: object
description: Input representation of a Realm Test connection object.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/operational/testrealms ( Test Azure AD connector
properties with client secret value set )'
: value:
status:
message: OK
status: STATUS_OK
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/object/operational/testrealms ( Test Azure AD connector
properties with client secret value cached )'
: value:
status:
message: OK
status: STATUS_OK
schema:
$ref: '#/components/schemas/RealmTest'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/operational/umbrellaprotectionpolicies:
get:
deprecated: false
description: '**Get Umbrella protection policy from Umbrella cloud.**'
operationId: getUmbrellaProtectionPolicy
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET ​/api​/fmc_config​/v1​/domain​/DomainUUID​/object/operational/umbrellaprotectionpolicies
( Example payloads for GET listing on umbrella protection polcy. )'
: value:
items:
- lastFetchTimeStamp: YYYY-DD-MMTHH:mm:ssZ
protectionPolicyNames:
- New Policy 1
- New Policy 2
- Default Policy
type: UmbrellaProtectionPolicy
links:
self: /api/fmc_config/v1/domain/DomainUUID/object/operational/umbrellaprotectionpolicies
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/UmbrellaProtectionPolicyListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create Umbrella protection policy. _Check the response section for applicable examples (if any)._**'
operationId: createUmbrellaProtectionPolicy
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UmbrellaProtectionPolicy'
type: object
description: Input representation of umbrella protection policy model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/UmbrellaProtectionPolicy'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/operational/usage:
get:
deprecated: false
description: '**Find usage of specified object uuid and type across objects and policies.
Supported object types:- Network:
NetworkAddress, Host, Network, Range, FQDN, NetworkGroup
- Port: Port, ProtocolPortObject, PortObjectGroup,
ICMPV4Object, ICMPV6Object, AnyProtocolPortObject
- VLAN tag: VlanTag, VlanGroupTag
- URL: Url, UrlGroup
**'
operationId: getObjectUsage
parameters:
- description: Specify uuid "uuid:object-uuid" and "type:object-type" and type of object
in: query
name: filter
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/operational/usage?filter=type:Network;uuid:005056A9-4E43-0ed3-0000-047244640278&offset=0&limit=100
( GET list of usages for specified object type and uuid )'
: value:
items:
- id: 005056A9-4E43-0ed3-0000-124554051587
name: Group01
type: Network
links:
self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/operational/usage?offset=0&limit=100&filter=type:Network;uuid:005056A9-4E43-0ed3-0000-047244640278
paging:
count: 1
limit: 100
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ObjectUsageListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/policylists:
get:
deprecated: false
description: '**Get the list of all policy lists.**'
operationId: getAllPolicyList
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/policylists ( Get all paginated policy list objects )':
value:
items:
- id: 00505686-A281-0ed3-0000-068719476739
links:
self: https:///host:port/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/policylists/policylist-UUID
name: GlobalPL
type: PolicyList
- id: policylist1-UUID
links:
self: https:///host:port/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/policylists/policylist-UUID1
name: GlobalPL123
type: PolicyListObject
links:
self: https://host:port/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/policylists?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/PolicyListListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a policy list. _Check the response section for applicable examples (if any)._**'
operationId: createPolicyList
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/policylists ( POST to create a policylist object )':
value:
action: DENY
description: ' '
extendedCommunityLists:
- id: ext_com_uuid
name: ext_com_1
type: ExtendedCommunityList
interfaceNames:
- inside
interfaces:
- id: security-zone-uuid
name: secZone
type: SecurityZone
matchCommunityExactly: false
metric: 111
name: GlobalPL123
overridable: false
tag: 2211
type: PolicyList
schema:
$ref: '#/components/schemas/PolicyList'
type: object
description: Payload representing Policy List object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/policylists ( POST to create a policylist object )':
value:
action: DENY
description: ' '
extendedCommunityLists:
- id: ext_com_uuid
name: ext_com_1
type: ExtendedCommunityList
id: new-policylist-UUID
interfaceNames:
- inside
interfaces:
- id: security-zone-uuid
name: secZone
type: SecurityZone
links:
self: https://host:port/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/policylists/new-policylist-UUID
matchCommunityExactly: false
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
lastUser:
name: admin
timestamp: 1540549081226.0
metric: 111
name: GlobalPL123
overridable: false
tag: 2211
type: PolicyList
schema:
$ref: '#/components/schemas/PolicyList'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/policylists/{objectId}:
delete:
deprecated: false
description: '**Delete the policy list associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deletePolicyList
parameters:
- description: Unique identifier of the policy list.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PolicyList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the policy list associated with the specified ID.**'
operationId: getPolicyList
parameters:
- description: Unique identifier of the policy list.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/policylists/policyListUUID ( GET a policy list
object for the given UUID )'
: value:
action: PERMIT
description: ' '
extendedCommunityLists:
- id: ext_com_uuid
name: ext_com_1
type: ExtendedCommunityList
id: policyListUUID
interfaceNames:
- inside
interfaces:
- id: security-zone-uuid
name: secZone
type: SecurityZone
links:
self: https://host:port/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/policylists/policyListUUID
matchCommunityExactly: false
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
lastUser:
name: admin
timestamp: 1540549081226.0
metric: 111
name: GlobalPL123
overridable: false
tag: 2211
type: PolicyList
schema:
$ref: '#/components/schemas/PolicyList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the policy list associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updatePolicyList
parameters:
- description: Unique identifier of the policy list.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/policylists/policylist-UUID ( PUT to update a policy list object )':
value:
action: PERMIT
description: ' '
extendedCommunityLists:
- id: ext_com_uuid
name: ext_com_1
type: ExtendedCommunityList
id: policylist-UUID
interfaceNames:
- inside
interfaces:
- id: security-zone-uuid
name: secZone
type: SecurityZone
matchCommunityExactly: false
metric: 111
name: GlobalPL123
overridable: false
tag: 2211
type: PolicyList
schema:
$ref: '#/components/schemas/PolicyList'
type: object
description: Payload representing Policy List object.
required: true
responses:
'200':
content:
application/json:
examples:
'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/policylists/policylist-UUID ( PUT to update a policy list object )':
value:
action: PERMIT
description: ' '
extendedCommunityLists:
- id: ext_com_uuid
name: ext_com_1
type: ExtendedCommunityList
id: policylist-UUID
interfaceNames:
- inside
interfaces:
- id: security-zone-uuid
name: secZone
type: SecurityZone
links:
self: https://host:port/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/policylists/policylist-UUID
matchCommunityExactly: false
metadata:
domain:
id: e276abec-e0f2-11e3-8169-6d9ed49b625f
name: Global
lastUser:
name: admin
timestamp: 1540549081226.0
metric: 111
name: GlobalPL123
overridable: false
tag: 2211
type: PolicyList
schema:
$ref: '#/components/schemas/PolicyList'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/portobjectgroups:
delete:
deprecated: false
description: '**Delete all port object groups. Use filtering to specify which port object groups will be deleted. _Check
the response section for applicable examples (if any)._**'
operationId: deleteMultiplePortObjectGroup
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: true
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/portobjectgroups/PortGroupObj2UUID ( Test DELETE
of PortGroup Object )'
: value:
id: PortGroupObj2UUID
name: portgroup_obj2
objects:
- id: ICMPV4ObjectUUID
type: ICMPV4Object
- id: ICMPV6ObjectUUID
type: ICMPV6Object
- id: ProtocolPortObjectUUID
type: ProtocolPortObject
type: PortObjectGroup
? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/portobjectgroups/ppgrp1_uuid?overrideTargetId=target_uuid
( Delete request to remove an override on port group )'
: value:
description: ' '
id: ppgrp1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/portobjectgroups/ppgrp1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 1527357918940.0
name: ppgrp1
objects:
- code: 0
icmpType: '3'
id: icmpv4_obj1_uuid
name: icmpv4_obj1
overridable: false
type: ICMPV4Object
- code: 0
icmpType: '3'
id: icmpv6_obj1_uuid
name: icmpv6_obj1
overridable: false
type: ICMPV6Object
- id: ppobj1_uuid
name: ppobj1
overridable: false
port: '123'
protocol: TCP
type: ProtocolPortObject
overridable: true
overrides:
parent:
id: ppgrp1_uuid
type: PortObjectGroup
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: PortObjectGroup
schema:
$ref: '#/components/schemas/PortObjectGroup'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the list of all port object groups.**'
operationId: getAllPortObjectGroup
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: Boolean indicating whether the protocol will be show in the metadata. This should be used in conjunction
with "expanded:true".
in: query
name: showProtocolNames
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/portobjectgroups ( Get all paginated portgroup
objects without offset and limit )'
: value:
items:
- description: ' '
id: ppgrp1_uuid
links:
parent: /api/fmc_config/v1/domain/domain_uuid/object/ports
self: /api/fmc_config/v1/domain/domain_uuid/object/portobjectgroups/ppgrp1_uuid
metadata:
domain:
id: domain_uuid
name: Global
lastUser:
name: pvs
parentType: Port
timestamp: 1528178431690.0
name: ppgrp1
objects:
- code: 0
icmpType: '3'
id: icmpv6_obj1_uuid
name: icmpv6_obj1
overridable: false
type: ICMPV6Object
- id: ppobj1_uuid
name: ppobj1
overridable: false
port: '123'
protocol: TCP
type: ProtocolPortObject
- code: 0
icmpType: '3'
id: icmpv4_obj1_uuid
name: icmpv4_obj1
overridable: false
type: ICMPV4Object
overridable: true
type: PortObjectGroup
links:
self: /api/fmc_config/v1/domain/domain_uuid/object/portobjectgroups?offset=0&limit=1&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/portobjectgroups?overrideTargetId=target_uuid&expanded=true
( Get all objects with given override target )'
: value:
items:
- description: ' '
id: ppgrp1_uuid
links:
parent: /api/fmc_config/v1/domain/domain_uuid/object/ports
self: /api/fmc_config/v1/domain/domain_uuid/object/portobjectgroups/ppgrp1_uuid?overrideTargetId=device_uuid
metadata:
domain:
id: domain_uuid
name: Global \ ASIA \ INDIA
lastUser:
name: pvs
parentType: Port
timestamp: 1528178429136.0
name: ppgrp1
objects:
- code: 0
icmpType: '3'
id: icmpv6_obj1_uuid
name: icmpv6_obj1
overridable: false
type: ICMPV6Object
- id: ppobj1_uuid
name: ppobj1
overridable: false
port: '123'
protocol: TCP
type: ProtocolPortObject
- code: 0
icmpType: '3'
id: icmpv4_obj1_uuid
name: icmpv4_obj1
overridable: false
type: ICMPV4Object
overridable: true
overrides:
parent:
id: ppgrp1_uuid
type: PortObjectGroup
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: PortObjectGroup
links:
self: /api/fmc_config/v1/domain/domain_uuid/object/portobjectgroups?offset=0&limit=1&overrideTargetId=device_uuid&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/PortObjectGroupListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a port object group. _Check the response section for applicable examples (if any)._**'
operationId: createMultiplePortObjectGroup
parameters:
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/portobjectgroups ( Test registration of PortObjectGroup
to create a new record )'
: value:
name: portgroup_obj1
objects:
- id: ICMPV4ObjectUUID
type: ICMPV4Object
- id: ICMPV6ObjectUUID
type: ICMPV6Object
- id: ProtocolPortObjectUUID
type: ProtocolPortObject
type: PortObjectGroup
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/portobjectgroups?bulk=true ( Bulk POST operation
on port object groups. )'
: value:
- name: portgroup_obj1
objects:
- id: icmpv4_objUuid
type: ICMPV4Object
- id: icmpv6_objUuid
type: ICMPV6Object
type: PortObjectGroup
- name: portgroup_obj2
objects:
- id: icmpv4_objUuid
type: ICMPV4Object
- id: protocol_port_obj_uuid
type: ProtocolPortObject
type: PortObjectGroup
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/portobjectgroups?bulk=true ( Bulk POST operation
on port object group with overrides )'
: value:
- description: abc
id: ppgrp_uuid
name: ppgrp
objects:
- id: icmp6_obj_uuid
name: icmp6_obj
type: ICMPV6Object
- id: ppobj_uuid
name: ppobj
type: ProtocolPortObject
overridable: true
overrides:
parent:
id: ppgrp_uuid
type: PortObjectGroup
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: PortObjectGroup
- description: abc
id: ppgrp_uuid
name: ppgrp
objects:
- id: icmp4_obj_uuid
name: icmp4_obj
type: ICMPV4Object
- id: icmp6_obj_uuid
name: icmp6_obj
type: ICMPV6Object
overridable: true
overrides:
parent:
id: ppgrp_uuid
type: PortObjectGroup
target:
id: device_uuid
name: FTDv_R1
type: Device
type: PortObjectGroup
? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/portobjectgroups ( POST request to create an override
on port group )'
: value:
description: ' '
id: ppgrp1_uuid
name: ppgrp1
objects:
- code: 0
icmpType: '3'
id: icmpv4_obj1_uuid
name: icmpv4_obj1
overridable: false
type: ICMPV4Object
- code: 0
icmpType: '3'
id: icmpv6_obj1_uuid
name: icmpv6_obj1
overridable: false
type: ICMPV6Object
- id: ppobj1_uuid
name: ppobj1
overridable: false
port: '123'
protocol: TCP
type: ProtocolPortObject
overridable: true
overrides:
parent:
id: ppgrp1_uuid
type: PortObjectGroup
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: PortObjectGroup
schema:
$ref: '#/components/schemas/PortObjectGroup'
type: object
description: The input port object group model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/portobjectgroups?bulk=true ( Bulk POST operation
on port object groups. )'
: value:
items:
- description: ' '
id: portgroup_obj1Uuid
links:
parent: /api/fmc_config/v1/domainUuid/object/ports
self: /api/fmc_config/v1/domainUuid/object/portobjectgroups/portgroup_obj1Uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: portgroup_obj1
objects:
- id: icmpv4_obj1Uuid
name: icmpv4_obj1
type: ICMPV4Object
- id: icmpv6_obj1Uuid
name: icmpv6_obj1
type: ICMPV6Object
overridable: false
type: PortObjectGroup
- description: ' '
id: portgroup_obj2Uuid
links:
parent: /api/fmc_config/v1/domainUuid/object/ports
self: /api/fmc_config/v1/domainUuid/object/portobjectgroups/portgroup_obj2Uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: portgroup_obj2
objects:
- id: icmpv4_obj1Uuid
name: icmpv4_obj1
type: ICMPV4Object
- id: pp1Uuid
name: pp1
type: ProtocolPortObject
overridable: false
type: PortObjectGroup
links:
self: /api/fmc_config/v1/domainUuid/object/portobjectgroups?bulk=true
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/portobjectgroups?bulk=true ( Bulk POST operation
on port object group with overrides )'
: value:
items:
- description: abc
id: ppgrp_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/portobjectgroups/ppgrp_uuid
metadata:
domain:
id: domain_uuid
name: Global \ EUROPE
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: ppgrp
objects:
- code: 1
icmpType: '1'
id: icmp6_obj_uuid
name: icmp6_obj
overridable: false
type: ICMPV6Object
- id: ppobj_uuid
name: ppobj
overridable: false
port: '12'
protocol: TCP
type: ProtocolPortObject
overridable: true
overrides:
parent:
id: ppgrp_uuid
type: PortObjectGroup
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: PortObjectGroup
- description: abc
id: ppgrp_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/portobjectgroups/ppgrp_uuid
metadata:
domain:
id: domain_uuid
name: Global \ ASIA
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: ppgrp
objects:
- code: 4
icmpType: '3'
id: icmp4_obj_uuid
name: icmp4_obj
overridable: false
type: ICMPV4Object
- code: 1
icmpType: '1'
id: icmp6_obj_uuid
name: icmp6_obj
overridable: false
type: ICMPV6Object
overridable: true
overrides:
parent:
id: ppgrp_uuid
type: PortObjectGroup
target:
id: device_uuid
name: FTDv_R1
type: Device
type: PortObjectGroup
links:
self: /api/fmc_config/v1/domain/domainUuid/object/portobjectgroups?bulk=true
? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/portobjectgroups ( POST request to create an override
on port group )'
: value:
id: ppgrp1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/portobjectgroups/ppgrp1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 0
name: ppgrp1
objects:
- code: 0
icmpType: '3'
id: icmpv4_obj1_uuid
name: icmpv4_obj1
overridable: false
type: ICMPV4Object
- code: 0
icmpType: '3'
id: icmpv6_obj1_uuid
name: icmpv6_obj1
overridable: false
type: ICMPV6Object
- id: ppobj1_uuid
name: ppobj1
overridable: false
port: '123'
protocol: TCP
type: ProtocolPortObject
overridable: true
overrides:
parent:
id: ppgrp1_uuid
type: PortObjectGroup
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: PortObjectGroup
schema:
$ref: '#/components/schemas/PortObjectGroup'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/portobjectgroups/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all overrides on the specified port object group. Response will always be in expanded form. If passed,
the "expanded" query parameter will be ignored.**'
operationId: getAllPortObjectGroupOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/hosts ( Get all overrides(device and deomain) on
Given PORTObjectGroup )'
: value:
items:
- description: ' '
id: portObjectGroupUUID
links:
self: /fmc_config/v1/domain/domainUUID/object/portobjectgroups/portObjectGroupUUID?overrideTargetId=targetUUID
metadata:
domain:
id: targetUUID
name: Global \ INDIA \ PUNE
lastUser:
name: user1
parentType: PortObject
timestamp: 1520419055913.0
name: PortGRP
objects:
- id: ProtocolPortObjectUUID
name: Bittorrent
overridable: false
port: 6881-6889
protocol: TCP
type: ProtocolPortObject
overridable: true
overrides:
parent:
id: portObjectGroupUUID
type: PortObjectGroup
target:
id: targetUUID
name: Global \ INDIA \ PUNE
type: Domain
type: PortObjectGroup
links:
self: /fmc_config/v1/domain/domainUUID/object/portobjectgroups/portObjectGroupUUID/overrides?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/PortObjectGroupOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/portobjectgroups/{containerUUID}/overrides/{objectId}:
get:
deprecated: false
description: '**Get the specified override of port object group object. Response will always be in expanded form. If
passed, the "expanded" query parameter will be ignored.**'
operationId: getPortObjectGroupOverride
parameters:
- description: Unique identifier of the port object group override.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PortObjectGroupOverride'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/portobjectgroups/{objectId}:
delete:
deprecated: false
description: '**Delete the port object group associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deletePortObjectGroup
parameters:
- description: Unique identifier of the port object group.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/portobjectgroups/PortGroupObj2UUID ( Test DELETE
of PortGroup Object )'
: value:
id: PortGroupObj2UUID
name: portgroup_obj2
objects:
- id: ICMPV4ObjectUUID
type: ICMPV4Object
- id: ICMPV6ObjectUUID
type: ICMPV6Object
- id: ProtocolPortObjectUUID
type: ProtocolPortObject
type: PortObjectGroup
? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/portobjectgroups/ppgrp1_uuid?overrideTargetId=target_uuid
( Delete request to remove an override on port group )'
: value:
description: ' '
id: ppgrp1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/portobjectgroups/ppgrp1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 1527357918940.0
name: ppgrp1
objects:
- code: 0
icmpType: '3'
id: icmpv4_obj1_uuid
name: icmpv4_obj1
overridable: false
type: ICMPV4Object
- code: 0
icmpType: '3'
id: icmpv6_obj1_uuid
name: icmpv6_obj1
overridable: false
type: ICMPV6Object
- id: ppobj1_uuid
name: ppobj1
overridable: false
port: '123'
protocol: TCP
type: ProtocolPortObject
overridable: true
overrides:
parent:
id: ppgrp1_uuid
type: PortObjectGroup
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: PortObjectGroup
schema:
$ref: '#/components/schemas/PortObjectGroup'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the port object group associated with the specified ID.**'
operationId: getPortObjectGroup
parameters:
- description: Unique identifier of the port object group.
in: path
name: objectId
required: true
schema:
type: string
- description: Get the overrides associated with the specified port object group.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: Boolean indicating whether the protocol will be show in the metadata. This should be used in conjunction
with "expanded:true".
in: query
name: showProtocolNames
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/portobjectgroups/PortGroupObjUUID ( Test GET of
PortGroup Object for a uuid )'
: value:
id: PortGroupObjUUID
name: portgroup_obj1
objects:
- id: ICMPV4ObjectUUID
type: ICMPV4Object
- id: ICMPV6ObjectUUID
type: ICMPV6Object
- id: ProtocolPortObjectUUID
type: ProtocolPortObject
type: PortObjectGroup
schema:
$ref: '#/components/schemas/PortObjectGroup'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the port object group associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updatePortObjectGroup
parameters:
- description: Unique identifier of the port object group.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/portobjectgroups/PortGroupObjUUID ( Test PUT of PortGroup
object to update record )'
: value:
id: PortGroupObjUUID
name: portgroup_obj1_updated
objects:
- id: ICMPV4ObjectUUID
type: ICMPV4Object
- id: ICMPV6ObjectUUID
type: ICMPV6Object
- id: ProtocolPortObjectUUID
type: ProtocolPortObject
type: PortObjectGroup
'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/portobjectgroups ( Test PUT of network object to create record )':
value:
name: portgroup_obj2
objects:
- id: ICMPV4ObjectUUID
type: ICMPV4Object
- id: ICMPV6ObjectUUID
type: ICMPV6Object
- id: ProtocolPortObjectUUID
type: ProtocolPortObject
type: Device
? 'Example 3 : PUT /fmc_config/v1/domain/DomainUUID/object/portobjectgroups/ppgrp1_uuid ( PUT request to update
an override on port object )'
: value:
description: ' '
id: ppgrp1_uuid
name: ppgrp1
objects:
- code: 0
icmpType: '3'
id: icmpv4_obj1_uuid
name: icmpv4_obj1
overridable: false
type: ICMPV4Object
- code: 0
icmpType: '3'
id: icmpv6_obj1_uuid
name: icmpv6_obj1
overridable: false
type: ICMPV6Object
- id: ppobj1_uuid
name: ppobj1
overridable: false
port: '123'
protocol: TCP
type: ProtocolPortObject
overridable: true
overrides:
parent:
id: ppgrp1_uuid
type: PortObjectGroup
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: PortObjectGroup
schema:
$ref: '#/components/schemas/PortObjectGroup'
type: object
description: The input port object group model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 3 : PUT /fmc_config/v1/domain/DomainUUID/object/portobjectgroups/ppgrp1_uuid ( PUT request to update
an override on port object )'
: value:
id: ppgrp1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/portobjectgroups/ppgrp1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 0
name: ppgrp1
objects:
- code: 0
icmpType: '3'
id: icmpv4_obj1_uuid
name: icmpv4_obj1
overridable: false
type: ICMPV4Object
- code: 0
icmpType: '3'
id: icmpv6_obj1_uuid
name: icmpv6_obj1
overridable: false
type: ICMPV6Object
- id: ppobj1_uuid
name: ppobj1
overridable: false
port: '123'
protocol: TCP
type: ProtocolPortObject
overridable: true
overrides:
parent:
id: ppgrp1_uuid
type: PortObjectGroup
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: PortObjectGroup
schema:
$ref: '#/components/schemas/PortObjectGroup'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ports:
get:
deprecated: false
description: '**Get list of all ports.**'
operationId: getPortObject
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PortObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/privateresourcegroups:
delete:
deprecated: false
description: '**Gets or modifies the PrivateResourceGroup object for a device. _Check the response section for applicable
examples (if any)._**'
operationId: deleteMultiplePrivateResourceGroup
parameters:
- description: '[DEV ERROR: Missing description]'
in: query
name: bulk
required: true
schema:
type: boolean
- description: '[DEV ERROR: Missing description]'
in: query
name: filter
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResourceGroup'
type: object
description: Input representation of PrivateResourceGroup object.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResourceGroup'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Gets or modifies the PrivateResourceGroup object for a device.**'
operationId: getAllPrivateResourceGroup
parameters:
- description: Provide PrivateResourceGroup object name.
in: query
name: name
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: filterOnDevice
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResourceGroupListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Gets or modifies the PrivateResourceGroup object for a device. _Check the response section for applicable
examples (if any)._**'
operationId: createMultiplePrivateResourceGroup
parameters:
- description: '[DEV ERROR: Missing description]'
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResourceGroup'
type: object
description: Input representation of PrivateResourceGroup object.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResourceGroup'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Gets or modifies the PrivateResourceGroup object for a device. _Check the response section for applicable
examples (if any)._**'
operationId: updateMultiplePrivateResourceGroup
parameters:
- description: '[DEV ERROR: Missing description]'
in: query
name: bulk
required: true
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResourceGroup'
type: object
description: Input representation of PrivateResourceGroup object.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResourceGroup'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/privateresourcegroups/{objectId}:
delete:
deprecated: false
description: '**Gets or modifies the PrivateResourceGroup object for a device. _Check the response section for applicable
examples (if any)._**'
operationId: deletePrivateResourceGroup
parameters:
- description: Unique identifier of a PrivateResourceGroup object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResourceGroup'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Gets or modifies the PrivateResourceGroup object for a device.**'
operationId: getPrivateResourceGroup
parameters:
- description: Unique identifier of a PrivateResourceGroup object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResourceGroup'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Gets or modifies the PrivateResourceGroup object for a device. _Check the response section for applicable
examples (if any)._**'
operationId: updatePrivateResourceGroup
parameters:
- description: Unique identifier of a PrivateResourceGroup object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResourceGroup'
type: object
description: Input representation of PrivateResourceGroup object.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResourceGroup'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/privateresources:
delete:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: deleteMultiplePrivateResource
parameters:
- description: '[DEV ERROR: Missing description]'
in: query
name: bulk
required: true
schema:
type: boolean
- description: '[DEV ERROR: Missing description]'
in: query
name: filter
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResource'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResource'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**[DEV ERROR: Missing description]**'
operationId: getAllPrivateResource
parameters:
- description: '[DEV ERROR: Missing description]'
in: query
name: name
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: filterOnDevice
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResourceListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: createMultiplePrivateResource
parameters:
- description: '[DEV ERROR: Missing description]'
in: query
name: bulk
required: false
schema:
type: boolean
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResource'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResource'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: updateMultiplePrivateResource
parameters:
- description: '[DEV ERROR: Missing description]'
in: query
name: bulk
required: true
schema:
type: boolean
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResource'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResource'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/privateresources/{objectId}:
delete:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: deletePrivateResource
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResource'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**[DEV ERROR: Missing description]**'
operationId: getPrivateResource
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResource'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: updatePrivateResource
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: query
name: commitId
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResource'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateResource'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/protocolportobjects:
delete:
deprecated: false
description: '**Delete all protocol port objects. Use filtering to specify which protocol port objects will be deleted.
_Check the response section for applicable examples (if any)._**'
operationId: deleteMultipleProtocolPortObject
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: true
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/protocolportobjects/protocoPortObj2UUID ( Test
DELETE of ProtocolPort Object )'
: value:
id: protocoPortObj2UUID
name: protocolport_obj2
port: 123
protocol: TCP
type: ProtocolPortObject
? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/protocolportobjects/ppobj1_uuid?overrideTargetId=target_uuid
( DELETE request to remove an override on protocol port object )'
: value:
description: ' '
id: ppobj1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/protocolportobjects/ppobj1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 1527350496236.0
name: ppobj1
overridable: true
overrides:
parent:
id: ppobj1_uuid
type: ProtocolPortObject
target:
id: target_uuid
name: 10.10.16.29
type: Device
port: '125'
protocol: TCP
type: ProtocolPortObject
schema:
$ref: '#/components/schemas/ProtocolPortObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the list of all protocol port objects.**'
operationId: getAllProtocolPortObject
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/protocolportobjects ( Get all paginated protocolport
objects without offset and limit )'
: {}
? 'Example 2 : GET /fmc_config/v1/domain/GlobalDomainUUID/object/protocolportobjects?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET ALL method from global domain for ProtocolPortObject when overrides are assigned to
child domain )'
: value:
items:
- description: ' '
id: protocoPortObjUUID
links:
parent: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/ports
self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/protocolportobjects/protocoPortObjUUID
metadata:
domain:
id: childDomainUUID
name: Global \ Asia
lastUser:
name: pvs
parentType: PortObject
name: pvs_protocol
overridable: true
overrides:
parent:
id: protocoPortObjUUID
type: ProtocolPortObject
target:
id: childDomainUUID
name: Global \ Asia
type: Domain
port: '123'
protocol: TCP
type: ProtocolPortObject
links:
self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/protocolportobjects?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 3 : GET /fmc_config/v1/domain/childDomainUUID/object/protocolportobjects?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET ALL method from child domain for ProtocolPortObject when overrides are assigned to child
domain )'
: value:
items:
- description: ' '
id: protocoPortObjUUID
links:
parent: https://fmc_host_ip/api/fmc_config/v1/domain/childDomainUUID/object/ports
self: https://fmc_host_ip/api/fmc_config/v1/domain/childDomainUUID/object/protocolportobjects/protocoPortObjUUID
metadata:
domain:
id: childDomainUUID
name: Global \ Asia
lastUser:
name: pvs
parentType: PortObject
name: pvs_protocol
overridable: true
overrides:
parent:
id: protocoPortObjUUID
type: ProtocolPortObject
target:
id: childDomainUUID
name: Global \ Asia
type: Domain
port: '123'
protocol: TCP
type: ProtocolPortObject
links:
self: https://fmc_host_ip/api/fmc_config/v1/domain/childDomainUUID/object/protocolportobjects?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ProtocolPortObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a protocol port object. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleProtocolPortObject
parameters:
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/protocolportobjects ( Test registration of ProtocolPortObject
to create a new record )'
: value:
name: protocolport_obj1
port: 123
protocol: TCP
type: ProtocolPortObject
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/protocolportobjects?bulk=true ( Bulk POST operation
on protocol port objects )'
: value:
- name: pp1
port: 123
protocol: TCP
type: ProtocolPortObject
- name: pp2
port: 456
protocol: UDP
type: ProtocolPortObject
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/protocolportobjects?bulk=true ( Bulk POST operation
on protocol port objects with overrides )'
: value:
- description: ' '
id: ppobj_uuid
name: ppobj
overridable: true
overrides:
parent:
id: ppobj_uuid
type: ProtocolPortObject
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
port: '15'
protocol: TCP
type: ProtocolPortObject
- description: ' '
id: ppobj_uuid
name: ppobj
overridable: true
overrides:
parent:
id: ppobj_uuid
type: ProtocolPortObject
target:
id: device_uuid
name: FTDv_R1
type: Device
port: '15'
protocol: UDP
type: ProtocolPortObject
? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/protocolportobjects ( POST request to create an
override on protocol port object )'
: value:
id: ppobj1_uuid
name: ppobj1
overridable: true
overrides:
parent:
id: ppobj1_uuid
type: ProtocolPortObject
target:
id: target_uuid
name: 10.10.16.29
type: Device
port: '123'
protocol: TCP
type: ProtocolPortObject
? 'Example 5 : POST /fmc_config/v1/domain/DomainUUID/object/protocolportobjects ( Test POST of ProtocolPort
object to create a new record )'
: value:
description: Testing Protocol port object
name: Shanghai
port: '25'
protocol: TCP
type: ProtocolPortObject
schema:
$ref: '#/components/schemas/ProtocolPortObject'
type: object
description: The input protocol port object model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/protocolportobjects?bulk=true ( Bulk POST operation
on protocol port objects )'
: value:
items:
- description: ' '
id: pp1Uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/protocolportobjects/pp1Uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: pp1
overridable: false
port: '123'
protocol: TCP
type: ProtocolPortObject
- description: ' '
id: pp2Uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/protocolportobjects/pp2Uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: pp2
overridable: false
port: '456'
protocol: UDP
type: ProtocolPortObject
links:
self: /api/fmc_config/v1/domain/domainUuid/object/protocolportobjects?bulk=true
? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/protocolportobjects?bulk=true ( Bulk POST operation
on protocol port objects with overrides )'
: value:
items:
- id: ppobj_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/protocolportobjects/ppobj_uuid
metadata:
domain:
id: domain_uuid
name: Global \ EUROPE
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: ppobj
overridable: true
overrides:
parent:
id: ppobj_uuid
type: ProtocolPortObject
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
port: '15'
protocol: TCP
type: ProtocolPortObject
- id: ppobj_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/protocolportobjects/ppobj_uuid
metadata:
domain:
id: domain_uuid
name: Global \ ASIA
lastUser:
name: pvs
parentType: Port
timestamp: 0
name: ppobj
overridable: true
overrides:
parent:
id: ppobj_uuid
type: ProtocolPortObject
target:
id: device_uuid
name: FTDv_R1
type: Device
port: '15'
protocol: UDP
type: ProtocolPortObject
links:
self: /api/fmc_config/v1/domain/domainUuid/object/protocolportobjects?bulk=true
? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/protocolportobjects ( POST request to create an
override on protocol port object )'
: value:
id: ppobj1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/protocolportobjects/ppobj1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 0
name: ppobj1
overridable: true
overrides:
parent:
id: ppobj1_uuid
type: ProtocolPortObject
target:
id: target_uuid
name: 10.10.16.29
type: Device
port: '123'
protocol: TCP
type: ProtocolPortObject
schema:
$ref: '#/components/schemas/ProtocolPortObject'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/protocolportobjects/{containerUUID}/overrides:
get:
deprecated: false
description: '**Get all overrides on the specified protocol port object. Response will always be in expanded form. If
passed, the "expanded" query parameter will be ignored.**'
operationId: getAllProtocolPortObjectOverride
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/protocolportobjects/portUUID/overrides ( Get all
(domain and device) overrides on gievn ProtocolPort Object )'
: value:
items:
- description: ' '
id: portUUID
links:
self: /fmc_config/v1/domain/domainUUID/object/protocolportobjects/portUUID?overrideTargetId=targetUUID
metadata:
domain:
id: domainUUID
name: Global \ INDIA
lastUser:
name: user
parentType: PortObject
timestamp: 1520343176850.0
name: protocol_port_1
overridable: true
overrides:
parent:
id: portUUID
type: ProtocolPortObject
target:
id: targetUUID
name: 10.10.19.25
type: Device
port: '5555'
protocol: TCP
type: ProtocolPortObject
- description: ' '
id: portUUID
links:
parent: /fmc_config/v1/domain/domainUUID/object/protocolportobjects/portUUID/ports
self: /fmc_config/v1/domain/domainUUID/object/protocolportobjects/portUUID?overrideTargetId=targetUUID
metadata:
domain:
id: domainUUID
name: Global \ BENGALURU
lastUser:
name: user
parentType: PortObject
timestamp: 1520343161346.0
name: protocol_port_1
overridable: true
overrides:
parent:
id: portUUID
type: ProtocolPortObject
target:
id: targetUUID
name: Global \ BENGALURU
type: Domain
port: '2222'
protocol: TCP
type: ProtocolPortObject
links:
self: /fmc_config/v1/domain/domainUUID/object/protocolportobjects/portUUID/overrides?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ProtocolPortObjectOverrideListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/protocolportobjects/{containerUUID}/overrides/{objectId}:
get:
deprecated: false
description: '**Get the specified override of protocol port object. Response will always be in expanded form. If passed,
the "expanded" query parameter will be ignored.**'
operationId: getProtocolPortObjectOverride
parameters:
- description: Unique identifier of the protocol port object override.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProtocolPortObjectOverride'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/protocolportobjects/{objectId}:
delete:
deprecated: false
description: '**Delete the protocol port object associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteProtocolPortObject
parameters:
- description: Unique identifier of the protocol port object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/protocolportobjects/protocoPortObj2UUID ( Test
DELETE of ProtocolPort Object )'
: value:
id: protocoPortObj2UUID
name: protocolport_obj2
port: 123
protocol: TCP
type: ProtocolPortObject
? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/protocolportobjects/ppobj1_uuid?overrideTargetId=target_uuid
( DELETE request to remove an override on protocol port object )'
: value:
description: ' '
id: ppobj1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/protocolportobjects/ppobj1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 1527350496236.0
name: ppobj1
overridable: true
overrides:
parent:
id: ppobj1_uuid
type: ProtocolPortObject
target:
id: target_uuid
name: 10.10.16.29
type: Device
port: '125'
protocol: TCP
type: ProtocolPortObject
schema:
$ref: '#/components/schemas/ProtocolPortObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the protocol port object associated with the specified ID.**'
operationId: getProtocolPortObject
parameters:
- description: Unique identifier of the protocol port object.
in: path
name: objectId
required: true
schema:
type: string
- description: Get the overrides associated with the specified protocol port object.
in: query
name: overrideTargetId
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/protocolportobjects/protocoPortObj1UUID ( Test
GET of ProtocolPort Object for a uuid )'
: value:
id: protocoPortObj1UUID
name: protocolport_obj1
port: 123
protocol: TCP
type: ProtocolPortObject
? 'Example 2 : GET /fmc_config/v1/domain/GlobalDomainUUID/object/protocolportobjects/protocolPortObjUUID?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET method from global domain on a specific ProtocolPortObject which has override assigned
as child domain )'
: value:
description: ' '
id: protocoPortObjUUID
links:
parent: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/ports
self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/protocolportobjects/protocoPortObjUUID
metadata:
domain:
id: childDomainUUID
name: Global \ Asia
lastUser:
name: pvs
parentType: PortObject
name: pvs_protocol
overridable: true
overrides:
parent:
id: protocoPortObjUUID
type: ProtocolPortObject
target:
id: childDomainUUID
name: Global \ Asia
type: Domain
port: '123'
protocol: TCP
type: ProtocolPortObject
? 'Example 3 : GET /fmc_config/v1/domain/childDomainUUID/object/protocolportobjects/protocolPortObjUUID?expanded=true&overrideTargetId=childDomainUUID
( Success: Test GET method from child domain on a ProtocolPortObject which has child domain assigned as
override )'
: value:
description: ' '
id: protocoPortObjUUID
links:
parent: https://fmc_host_ip/api/fmc_config/v1/domain/childDomainUUID/object/ports
self: https://fmc_host_ip/api/fmc_config/v1/domain/childDomainUUID/object/protocolportobjects/protocoPortObjUUID
metadata:
domain:
id: childDomainUUID
name: Global \ Asia
lastUser:
name: pvs
parentType: PortObject
name: pvs_protocol
overridable: true
overrides:
parent:
id: protocoPortObjUUID
type: ProtocolPortObject
target:
id: childDomainUUID
name: Global \ Asia
type: Domain
port: '123'
protocol: TCP
type: ProtocolPortObject
? 'Example 4 : GET /fmc_config/v1/domain/childDomainUUID/object/protocolportobjects/protocolPortObjUUID?expanded=true&overrideTargetId=deviceUUID
( Success: Test GET method from child domain on a ProtocolPortObject which has device assigned as override
)'
: value:
description: ' '
id: protocoPortObjUUID
links:
parent: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/ports
self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/protocolportobjects/protocoPortObjUUID
metadata:
domain:
id: childDomainUUID
name: Global \ Asia
lastUser:
name: api
parentType: PortObject
name: pvs_protocol
overridable: true
overrides:
parent:
id: protocoPortObjUUID
type: ProtocolPortObject
target:
id: deviceUUID
name: device_name
type: Device
port: '123'
protocol: TCP
type: ProtocolPortObject
schema:
$ref: '#/components/schemas/ProtocolPortObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the protocol port object associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateProtocolPortObject
parameters:
- description: Unique identifier of the protocol port object.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/protocolportobjects/protocoPortObj1UUID ( Test PUT
of ProtocolPort object to update record )'
: value:
id: protocoPortObj1UUID
name: protocolport_obj1_updated
port: 1
protocol: TCP
type: ProtocolPortObject
? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/protocolportobjects/ppobj1_uuid ( PUT request to
update an override on protocol port object )'
: value:
id: ppobj1_uuid
name: ppobj1
overridable: true
overrides:
parent:
id: ppobj1_uuid
type: ProtocolPortObject
target:
id: target_uuid
name: 10.10.16.29
type: Device
port: '125'
protocol: TCP
type: ProtocolPortObject
schema:
$ref: '#/components/schemas/ProtocolPortObject'
type: object
description: The input protocol port object model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/protocolportobjects/ppobj1_uuid ( PUT request to
update an override on protocol port object )'
: value:
id: ppobj1_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/ports
self: /api/fmc_config/v1/domain/domainUuid/object/protocolportobjects/ppobj1_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
lastUser:
name: admin
parentType: Port
timestamp: 0
name: ppobj1
overridable: true
overrides:
parent:
id: ppobj1_uuid
type: ProtocolPortObject
target:
id: target_uuid
name: 10.10.16.29
type: Device
port: '125'
protocol: TCP
type: ProtocolPortObject
schema:
$ref: '#/components/schemas/ProtocolPortObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/radiusservergroups:
get:
deprecated: false
description: '**Get the list of all Radius server groups.**'
operationId: getAllRadiusServerGroupModel
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/radiusservergroups ( Test GET ALL Success of Radius Server Group )':
value:
items:
- description: Radius-Server-1 desc
dynamicAuthorizationPort: 1800
enableAuthorizeOnly: true
enableDynamicAuthorization: true
enableInterimAccountUpdate: true
enableMergeDacl: true
groupAccountingMode: MULTIPLE
id: RadiusServerGroupUUID
interimAccountUpdateInterval: 110
mergeDaclPlacementOrder: MERGE_DACL_AFTER_AV_PAIR_ACL
metadata:
domain:
id: DomainUUID
name: Global
type: Domain
name: Radius-Server-1
radiusServers:
- host: string
interface:
id: InterfaceUUID
name: String
type: SecurityZone
redirectACL:
id: ExtendedAccessListUUID
name: string
type: ExtendedAccessList
serverAccountingPort: 1813
serverAuthenticationPort: 1812
serverSecretKey: '****'
timeout: 110
useRoutingToSelectInterface: true
realm:
id: RealmUUID
name: Realm
type: Realm
retryInterval: 4
type: RadiusServerGroup
- description: Radius-Server-2 desc
dynamicAuthorizationPort: 1800
enableAuthorizeOnly: true
enableDynamicAuthorization: true
enableInterimAccountUpdate: true
enableMergeDacl: true
groupAccountingMode: MULTIPLE
id: RadiusServerGroupUUID
interimAccountUpdateInterval: 110
mergeDaclPlacementOrder: MERGE_DACL_AFTER_AV_PAIR_ACL
metadata:
domain:
id: DomainUUID
name: Global
type: Domain
name: Radius-Server-2
radiusServers:
- host: string
interface:
id: InterfaceUUID
name: String
type: SecurityZone
redirectACL:
id: ExtendedAccessListUUID
name: string
type: ExtendedAccessList
serverAccountingPort: 1813
serverAuthenticationPort: 1812
serverSecretKey: '****'
timeout: 110
useRoutingToSelectInterface: true
realm:
id: RealmUUID
name: Realm
type: Realm
retryInterval: 4
type: RadiusServerGroup
schema:
$ref: '#/components/schemas/RadiusServerGroupModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a Radius server group. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleRadiusServerGroupModel
parameters:
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/radiusservergroups ( POST operation for Radius Server Group )':
value:
description: Radius-Server-1 desc
dynamicAuthorizationPort: 1800
enableAuthorizeOnly: true
enableDynamicAuthorization: true
enableInterimAccountUpdate: true
enableMergeDacl: true
groupAccountingMode: MULTIPLE
interimAccountUpdateInterval: 110
mergeDaclPlacementOrder: MERGE_DACL_AFTER_AV_PAIR_ACL
name: Radius-Server-1
radiusServers:
- host: string
interface:
id: InterfaceUUID
name: String
type: SecurityZone
redirectACL:
id: ExtendedAccessListUUID
name: string
type: ExtendedAccessList
serverAccountingPort: 1813
serverAuthenticationPort: 1812
serverSecretKey: '****'
timeout: 110
useRoutingToSelectInterface: true
realm:
id: RealmUUID
name: Realm
type: Realm
retryInterval: 4
type: RadiusServerGroup
'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/radiusservergroups ( POST operation for Radius Server Group )':
value:
description: Radius-Server-1 desc
enableAuthorizeOnly: false
enableDynamicAuthorization: false
enableInterimAccountUpdate: false
enableMergeDacl: true
groupAccountingMode: MULTIPLE
mergeDaclPlacementOrder: MERGE_DACL_AFTER_AV_PAIR_ACL
name: Radius-Server-1
radiusServers:
- host: string
serverAccountingPort: 1813
serverAuthenticationPort: 1812
serverSecretKey: '****'
timeout: 110
useRoutingToSelectInterface: true
realm:
id: RealmUUID
name: Realm
type: Realm
retryInterval: 4
type: RadiusServerGroup
schema:
$ref: '#/components/schemas/RadiusServerGroupModel'
type: object
description: Input representation of Radius Server Group object.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/radiusservergroups ( POST operation for Radius Server Group )':
value:
description: Radius-Server-1 desc
dynamicAuthorizationPort: 1800
enableAuthorizeOnly: true
enableDynamicAuthorization: true
enableInterimAccountUpdate: true
enableMergeDacl: true
groupAccountingMode: MULTIPLE
interimAccountUpdateInterval: 110
links:
parent: /api/fmc_config/v1/domain/DomainUUID/object/radiusservergroups
self: /api/fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID
mergeDaclPlacementOrder: MERGE_DACL_AFTER_AV_PAIR_ACL
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1524129145233.0
name: Radius-Server-1
radiusServers:
- host: string
interface:
id: InterfaceUUID
name: String
type: SecurityZone
redirectACL:
id: ExtendedAccessListUUID
name: string
type: ExtendedAccessList
serverAccountingPort: 1813
serverAuthenticationPort: 1812
serverSecretKey: '****'
timeout: 110
useRoutingToSelectInterface: true
realm:
id: RealmUUID
name: Realm
type: Realm
retryInterval: 4
type: RadiusServerGroup
'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/radiusservergroups ( POST operation for Radius Server Group )':
value:
description: Radius-Server-1 desc
enableAuthorizeOnly: false
enableDynamicAuthorization: false
enableInterimAccountUpdate: false
enableMergeDacl: true
groupAccountingMode: MULTIPLE
links:
parent: /api/fmc_config/v1/domain/DomainUUID/object/radiusservergroups
self: /api/fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID
mergeDaclPlacementOrder: MERGE_DACL_AFTER_AV_PAIR_ACL
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1524129145233.0
name: Radius-Server-1
radiusServers:
- host: string
serverAccountingPort: 1813
serverAuthenticationPort: 1812
serverSecretKey: '****'
timeout: 110
useRoutingToSelectInterface: true
realm:
id: RealmUUID
name: Realm
type: Realm
retryInterval: 4
type: RadiusServerGroup
schema:
$ref: '#/components/schemas/RadiusServerGroupModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/radiusservergroups/{objectId}:
delete:
deprecated: false
description: '**Delete the Radius server group associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteRadiusServerGroupModel
parameters:
- description: Unique identifier of the Radius server group.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID ( DELETE
operation for Radius Server Group )'
: value:
description: Radius-Server-1 desc
dynamicAuthorizationPort: 1800
enableAuthorizeOnly: true
enableDynamicAuthorization: true
enableInterimAccountUpdate: true
enableMergeDacl: true
groupAccountingMode: MULTIPLE
id: RadiusServerGroupUUID
interimAccountUpdateInterval: 110
links:
parent: /api/fmc_config/v1/domain/DomainUUID/object/radiusservergroups
self: /api/fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID
mergeDaclPlacementOrder: MERGE_DACL_AFTER_AV_PAIR_ACL
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1524129145233.0
name: Radius-Server-1
radiusServers:
- host: string
interface:
id: InterfaceUUID
name: String
type: SecurityZone
redirectACL:
id: ExtendedAccessListUUID
name: string
type: ExtendedAccessList
serverAccountingPort: 1813
serverAuthenticationPort: 1812
serverSecretKey: '****'
timeout: 110
useRoutingToSelectInterface: true
realm:
id: RealmUUID
name: Realm
type: Realm
retryInterval: 4
type: RadiusServerGroup
schema:
$ref: '#/components/schemas/RadiusServerGroupModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the Radius server group associated with the specified ID.**'
operationId: getRadiusServerGroupModel
parameters:
- description: Unique identifier of the Radius server group.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/Radiusservergroups/objectId ( Get paginated Radius
Server Group objects with limit=1 )'
: value:
description: Radius-Server-3 desc
dynamicAuthorizationPort: 1800
enableAuthorizeOnly: true
enableDynamicAuthorization: true
enableInterimAccountUpdate: true
enableMergeDacl: true
groupAccountingMode: MULTIPLE
id: RadiusServerGroupUUID
interimAccountUpdateInterval: 110
mergeDaclPlacementOrder: MERGE_DACL_AFTER_AV_PAIR_ACL
metadata:
domain:
id: DomainUUID
name: Global
type: Domain
name: Radius-Server
radiusServers:
- host: string
interface:
id: InterfaceUUID
name: String
type: SecurityZone
redirectACL:
id: ExtendedAccessListUUID
name: string
type: ExtendedAccessList
serverAccountingPort: 1813
serverAuthenticationPort: 1812
serverSecretKey: '****'
timeout: 110
useRoutingToSelectInterface: true
realm:
id: RealmUUID
name: Realm
type: Realm
retryInterval: 4
type: RadiusServerGroup
schema:
$ref: '#/components/schemas/RadiusServerGroupModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
put:
deprecated: false
description: '**Modify the Radius server group associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateRadiusServerGroupModel
parameters:
- description: Unique identifier of the Radius server group.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID ( Put operation
for Radius Server Group )'
: value:
description: Radius-Server-1 desc
dynamicAuthorizationPort: 1800
enableAuthorizeOnly: true
enableDynamicAuthorization: true
enableInterimAccountUpdate: true
enableMergeDacl: true
groupAccountingMode: MULTIPLE
id: RadiusServerGroupUUID
interimAccountUpdateInterval: 110
mergeDaclPlacementOrder: MERGE_DACL_AFTER_AV_PAIR_ACL
name: Radius-Server-1
radiusServers:
- host: string
interface:
id: InterfaceUUID
name: String
type: SecurityZone
redirectACL:
id: ExtendedAccessListUUID
name: string
type: ExtendedAccessList
serverAccountingPort: 1813
serverAuthenticationPort: 1812
serverSecretKey: '****'
timeout: 110
useRoutingToSelectInterface: true
realm:
id: RealmUUID
name: Realm
type: Realm
retryInterval: 4
type: RadiusServerGroup
? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID ( Put operation
for Radius Server Group )'
: value:
description: Radius-Server-1 desc
enableAuthorizeOnly: false
enableDynamicAuthorization: false
enableInterimAccountUpdate: false
enableMergeDacl: true
groupAccountingMode: MULTIPLE
id: RadiusServerGroupUUID
interimAccountUpdateInterval: 110
mergeDaclPlacementOrder: MERGE_DACL_AFTER_AV_PAIR_ACL
name: Radius-Server-2
radiusServers:
- host: string
serverAccountingPort: 1813
serverAuthenticationPort: 1812
serverSecretKey: '****'
timeout: 110
useRoutingToSelectInterface: true
realm:
id: RealmUUID
name: Realm
type: Realm
retryInterval: 4
type: RadiusServerGroup
schema:
$ref: '#/components/schemas/RadiusServerGroupModel'
type: object
description: Input representation of Radius Server Group object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID ( Put
operation for Radius Server Group )'
: value:
description: Radius-Server-1 desc
dynamicAuthorizationPort: 1800
enableAuthorizeOnly: true
enableDynamicAuthorization: true
enableInterimAccountUpdate: true
enableMergeDacl: true
groupAccountingMode: MULTIPLE
interimAccountUpdateInterval: 110
links:
parent: /api/fmc_config/v1/domain/DomainUUID/object/radiusservergroups
self: /api/fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID
mergeDaclPlacementOrder: MERGE_DACL_AFTER_AV_PAIR_ACL
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1524129145233.0
name: Radius-Server-1
radiusServers:
- host: string
interface:
id: InterfaceUUID
name: String
type: SecurityZone
redirectACL:
id: ExtendedAccessListUUID
name: string
type: ExtendedAccessList
serverAccountingPort: 1813
serverAuthenticationPort: 1812
serverSecretKey: '****'
timeout: 110
useRoutingToSelectInterface: true
realm:
id: RealmUUID
name: Realm
type: Realm
retryInterval: 4
type: RadiusServerGroup
? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID ( Put
operation for Radius Server Group )'
: value:
description: Radius-Server-1 desc
enableAuthorizeOnly: false
enableDynamicAuthorization: false
enableInterimAccountUpdate: false
enableMergeDacl: true
groupAccountingMode: MULTIPLE
interimAccountUpdateInterval: 110
links:
parent: /api/fmc_config/v1/domain/DomainUUID/object/radiusservergroups
self: /api/fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID
mergeDaclPlacementOrder: MERGE_DACL_AFTER_AV_PAIR_ACL
metadata:
domain:
id: DomainUUID
name: Global
lastUser:
name: rest
timestamp: 1524129145233.0
name: Radius-Server-1
radiusServers:
- host: string
serverAccountingPort: 1813
serverAuthenticationPort: 1812
serverSecretKey: '****'
timeout: 110
useRoutingToSelectInterface: true
realm:
id: RealmUUID
name: Realm
type: Realm
retryInterval: 4
type: RadiusServerGroup
schema:
$ref: '#/components/schemas/RadiusServerGroupModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ranges:
delete:
deprecated: false
description: '**Delete all range objects. Use filtering to specify which range objects will be deleted. _Check the response
section for applicable examples (if any)._**'
operationId: deleteMultipleRangeObject
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: true
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/object/ranges/Range-obj-UUID-1 ( DELETE a range object
for the given UUID )'
: value:
description: Test Description
id: Range-obj-UUID-1
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/ranges/Range-obj-UUID-1
metadata:
domain:
id: domainUUID
name: Global \ TestDomain
ipType: V_6
lastUser:
name: testuser
parentType: NetworkAddress
name: TestRange2
overridable: false
type: Range
value: 2003::3-2003::4
? 'Example 2 : DELETE /fmc_config/v1/domain/domainUUID/object/ranges/range2_uuid?overrideTargetId=target_uuid
( DELETE request to delete an override on given range object )'
: value:
description: ' '
id: range2_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/ranges/range2_uuid?overrideTargetId=target_uuid
metadata:
domain:
id: domainUuid
name: Global
ipType: V_4
lastUser:
name: admin
parentType: NetworkAddress
timestamp: 1527243122526.0
name: range2
overridable: true
overrides:
parent:
id: range2_uuid
type: Range
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: Range
value: 1.1.1.1-1.1.1.10
schema:
$ref: '#/components/schemas/RangeObject'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
get:
deprecated: false
description: '**Get the list of all range objects.**'
operationId: getAllRangeObject
parameters:
- description: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}"
to search for both name and value.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
'Example 1 : GET /fmc_config/v1/domain/domainUUID/object/ranges ( Get all paginated Range objects )':
value:
items:
- id: 00505690-1DF7-0ed3-0000-236223201462
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/ranges/00505690-1DF7-0ed3-0000-236223201462
name: Test1
type: Range
- id: Range-obj-UUID-2
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/ranges/Range-obj-UUID-2
name: TestRange
type: Range
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/ranges?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/ranges?expanded=true ( Get all paginated Range
objects with expanded set to true )'
: value:
items:
- description: Test1
id: 00505690-1DF7-0ed3-0000-236223201462
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/ranges/00505690-1DF7-0ed3-0000-236223201462
metadata:
domain:
id: Global-domain-UUID
name: Global
ipType: V_4
lastUser:
name: testuser
parentType: NetworkAddress
name: Test1
overridable: false
type: Range
value: 10.20.40.50-10.20.40.60
- description: ' '
id: Range-obj-UUID-2
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/ranges/Range-obj-UUID-2
metadata:
domain:
id: Global-domain-UUID
name: Global
ipType: V_4
lastUser:
name: testuser
parentType: NetworkAddress
name: TestRange
overridable: false
type: Range
value: 10.20.30.4-10.20.30.128
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/ranges?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 3 : GET /fmc_config/v1/domain/domainUUID/object/ranges?overrideTargetId=target_uuid&expanded=true
( Get all range objects with overrides )'
: value:
items:
- description: ' '
id: range_uuid
links:
parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses
self: /api/fmc_config/v1/domain/domainUuid/object/ranges/range_uuid?overrideTargetId=device_uuid
metadata:
domain:
id: domain_Uuid
name: Global \ ASIA \ INDIA
ipType: V_4
lastUser:
name: pvs
parentType: NetworkAddress
timestamp: 1528118458516.0
name: range1
overridable: true
overrides:
parent:
id: range_uuid
type: Range
target:
id: device_uuid
name: 10.10.16.29
type: Device
type: Range
value: 1.1.1.1-1.1.1.20
links:
self: /api/fmc_config/v1/domain/domainUuid/object/ranges?offset=0&limit=1&overrideTargetId=device_uuid&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/RangeObjectListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Object
post:
deprecated: false
description: '**Create a range object. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleRangeObject
parameters:
- description: Boolean indicating whether this is a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/ranges ( POST to create a range object )':
value:
description: Test Description
name: TestRange2
type: Range
value: 10.4.30.40-10.4.30.50
'Example 2 : POST /fmc_config/v1/domain/domainUUID/object/ranges?bulk=true ( POST to create a range object )':
value:
- description: Range obj 1
name: Range1
type: Range
value: 10.4.30.40-10.4.30.50
- description: Range obj2
name: Range2
type: Range
value: 1.2.3.4-1.2.3.10
? 'Example 3 : POST /fmc_config/v1/domain/domainUUID/object/ranges?bulk=true ( Bulk POST to create a range objects
with overrides )'
: value:
- description: ' '
id: range_obj_uuid
name: range_obj
overridable: true
overrides:
parent:
id: range_obj_uuid
type: Range
target:
id: domain_uuid
name: Global \ EUROPE
type: Domain
type: Range
value: 10.10.10.1-10.10.10.10
- description: ' '
id: range_obj_uuid
name: range_obj
overridable: true
overrides:
parent:
id: range_obj_uuid
type: Range
target:
id: device_uuid
name: FTDv_R1
type: Device
type: Range
value: 20.20.20.1-20.20.20.10
'Example 4 : POST /fmc_config/v1/domain/domainUUID/object/ranges ( POST request to create override on a range object. )':
value:
description: ' '
id: range2_uuid
name: range2
overridable: true
overrides:
parent:
id: range2_uuid
type: Host
target:
id: target_uuid
name: 10.10.16.29
type: Device
type: Range
value: 1.1.1.1-1.1.1.10
schema:
$ref: '#/components/schemas/RangeObject'
type: object
description: Input representation of address range.
required: true
responses:
'201':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/ranges ( POST to create a range object )':
value:
id: Range-obj-UUID-1
links:
parent: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/ranges/Range-obj-UUID-1
metadata:
domain:
id: domainUUID
name: Global \ TestDomain
ipType: V_4
lastUser:
name: testuser
parentType: NetworkAddress
name: TestRange2
overridable: false
type: Range
value: 10.4.30.40-10.4.30.50
'Example 2 : POST /fmc_config/v1/domain/domainUUID/object/ranges?bulk=true ( POST to create a range object )':
value:
items:
- description: Range obj 1
id: range1Uuid
links:
parent: