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: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses self: /api/fmc_config/v1/domain/domainUuid/object/ranges/range1Uuid metadata: domain: id: domainUuid name: Global ipType: V_4 lastUser: name: pvs parentType: NetworkAddress timestamp: 0 name: Range1 overridable: false type: Range value: 10.4.30.40-10.4.30.50 - description: Range obj2 id: range2Uuid links: parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses self: /api/fmc_config/v1/domain/domainUuid/object/ranges/range2Uuid metadata: domain: id: domainUuid name: Global ipType: V_4 lastUser: name: pvs parentType: NetworkAddress timestamp: 0 name: Range2 overridable: false type: Range value: 1.2.3.4-1.2.3.10 links: self: /api/fmc_config/v1/domain/domainUuid/object/ranges?bulk=true ? 'Example 3 : POST /fmc_config/v1/domain/domainUUID/object/ranges?bulk=true ( Bulk POST to create a range objects with overrides )' : value: items: - id: range_obj_uuid links: parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses self: /api/fmc_config/v1/domain/domainUuid/object/ranges/range_obj_uuid metadata: domain: id: domain_uuid name: Global \ EUROPE ipType: V_4 lastUser: name: pvs parentType: NetworkAddress timestamp: 0 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 - id: range_obj_uuid links: parent: /api/fmc_config/v1/domain/domainUuid/object/networkaddresses self: /api/fmc_config/v1/domain/domainUuid/object/ranges/range_obj_uuid metadata: domain: id: domain_uuid name: Global \ ASIA ipType: V_4 lastUser: name: pvs parentType: NetworkAddress timestamp: 0 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 links: self: /api/fmc_config/v1/domain/domainUuid/object/ranges?bulk=true 'Example 4 : POST /fmc_config/v1/domain/domainUUID/object/ranges ( POST request to create override on a range object. )': value: 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: 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: 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/ranges/{containerUUID}/overrides: get: deprecated: false description: '**Get all overrides on the specified range object. Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored.**' operationId: getAllRangeOverride 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/ranges/rangeUUID/overrides ( Get all overrides on Given range object )' : value: items: - description: ' ' id: rangeUUID links: self: /fmc_config/v1/domain/domainUUID/object/ranges/rangeUUID?overrideTargetId=targetUUID metadata: domain: id: domainUUID name: Global \ BENGALURU lastUser: name: user1 timestamp: 1520336790963.0 name: Range_1 overridable: true overrides: parent: id: rangeUUID type: Range target: id: targetUUID name: Global \ BENGALURU type: Domain type: Range value: 1.2.3.7-1.2.3.9 links: self: /fmc_config/v1/domain/domainUUID/object/ranges/rangeUUID/overrides?offset=0&limit=1 paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/RangeOverrideListContainer' 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/{containerUUID}/overrides/{objectId}: get: deprecated: false description: '**Get the specified override of range object. Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored.**' operationId: getRangeOverride parameters: - description: Unique identifier of the range 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/RangeOverride' 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/{objectId}: delete: deprecated: false description: '**Delete the range object associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteRangeObject parameters: - description: Unique identifier of the range 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/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 range object associated with the specified ID.**' operationId: getRangeObject parameters: - description: Unique identifier of the range object. in: path name: objectId required: true schema: type: string - description: Get the overrides associated with the specified range 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/ranges/Range-obj-UUID-1 ( GET 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 schema: $ref: '#/components/schemas/RangeObject' 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 range object associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateRangeObject parameters: - description: Unique identifier of the range 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/ranges/Range-obj-UUID-1 ( PUT to update a range object )': value: description: Test Description id: Range-obj-UUID-1 name: TestRange2 type: Range value: 2003::3-2003::4 ? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/object/ranges/range2_uuid ( PUT request to update an 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: '200': content: application/json: examples: 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/ranges/Range-obj-UUID-1 ( PUT to update 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_6 lastUser: name: testuser parentType: NetworkAddress name: TestRange2 overridable: false type: Range value: 2003::3-2003::4 ? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/object/ranges/range2_uuid ( PUT request to update an override on a Range object )' : value: 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: 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 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/realms: get: deprecated: false description: '**Get the list of all realms.**' operationId: getAllRealm parameters: - description: Filter criteria can be specified using the format name:name;realmType:realmType;enabled:enabled

name -- Name of the realm to be queried. May start with ^ to indicate filtering by names starting with, rather than containing.
realmType -- Type of the realm to be queried. A comma seperated list of realm types.
enabled -- Either true or false.
in: query name: filter required: false schema: type: string - description: Name of the realm to be queried. in: query name: name required: false schema: type: string - description: 'Type of the realm. Possible values are: AD, LDAP, Local and SAML.' in: query name: realmType required: false schema: type: string - description: Either true or false. in: query name: enabled 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/realms?limit=2 ( Get all paginated Realm with limit set 2 )': value: items: - id: RealmUUID links: self: /fmc_config/v1/domain/domainUUID/object/realms/RealmUUID name: Realm_2 type: Realm - id: RealmUUID links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/realms/RealmUUID name: Realm_3 type: Realm links: self: /fmc_config/v1/domain/domainUUID/object/realms?offset=0&limit=2 paging: count: 5 limit: 2 next: - /fmc_config/v1/domain/domainUUID/object/realms?offset=2&limit=2 - /fmc_config/v1/domain/domainUUID/object/realms?offset=4&limit=1 offset: 0 pages: 3 ? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/realms?limit=2&expanded=true ( Get all paginated application with limit set 2 )' : value: items: - activeAuthSessionTimeout: 5 adJoinPassword: '********' adJoinUsername: administrator@ntd-test.cisco.com adPrimaryDomain: ntd-test.cisco.com baseDn: dc=ntd-test,dc=cisco,dc=com description: ntd-test domain dirPassword: '*******' dirUsername: administrator@ntd-test.cisco.com directoryConfigurations: - encryptionCert: id: fd01c1ca-9700-11ea-9f57-f3f11d78105e name: WIN2012-AD1.ntd-test.cisco.com_cert type: PKI_ExternalCA encryptionProtocol: LDAPS hostname: WIN2012-AD1.ntd-test.cisco.com id: 1 interface: id: bf9be468-9620-11ea-8b38-f1d4b3e2e3ba name: myIntZone type: InterfaceGroup port: 636 useRoutingToSelectInterface: false enabled: true excludedGroups: [] excludedUsers: - u64k_1 failedAuthSessionTimeout: 1440 groupAttribute: member groupDn: dc=ntd-test,dc=cisco,dc=com guestSessionTimeout: 1440 id: 625d610e-961c-11ea-83e4-8edad9fcf62e includedGroups: - G3K_1 - G3K_2 includedUsers: [] links: self: /fmc_config/v1/domain/domainUUID/object/realms/RealmUUID metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain duplicatedDomain: false hasUnresolvedReferences: false isDownloading: false readOnly: reason: SYSTEM state: true systemDefined: true name: ntd-test.cisco.com realm_id: 2 realmType: AD tsAgentSessionTimeout: 1440 type: Realm updateHour: 0 updateInterval: 24 version: '1' - activeAuthSessionTimeout: 5 adJoinPassword: '********' adJoinUsername: administrator@ntd2-test.cisco.com adPrimaryDomain: ntd-test2.cisco.com baseDn: dc=ntd-test2,dc=cisco,dc=com description: ntd-test2 domain dirPassword: '*******' dirUsername: administrator@ntd-test2.cisco.com directoryConfigurations: - encryptionCert: id: abc1c1ca-9700-11ea-9f57-f3f11d78105e name: WIN2012-AD1.ntd-test2.cisco.com_cert type: PKI_ExternalCA encryptionProtocol: LDAPS hostname: WIN2012-AD1.ntd-test2.cisco.com id: 1 interface: id: abcbe468-9620-11ea-8b38-f1d4b3e2e3ba name: myIntZone2 type: InterfaceGroup port: 636 useRoutingToSelectInterface: false enabled: true excludedGroups: [] excludedUsers: - u64k_11 failedAuthSessionTimeout: 1440 groupAttribute: member groupDn: dc=ntd-test2,dc=cisco,dc=com guestSessionTimeout: 1440 id: 759d610e-961c-11ea-83e4-8edad9fcf62e includedGroups: - G3K_5 - G3K_7 includedUsers: [] links: self: /fmc_config/v1/domain/domainUUID/object/realms/RealmUUID metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain duplicatedDomain: false hasUnresolvedReferences: false isDownloading: false readOnly: reason: SYSTEM state: true systemDefined: true name: ntd-test2.cisco.com realm_id: 2 realmType: AD tsAgentSessionTimeout: 1440 type: Realm updateHour: 0 updateInterval: 24 version: '1' links: self: /fmc_config/v1/domain/domainUUID/object/realms?offset=0&limit=5 paging: count: 5 limit: 2 next: - /fmc_config/v1/domain/domainUUID/object/realms?offset=2&limit=2 - /fmc_config/v1/domain/domainUUID/object/realms?offset=4&limit=1 offset: 0 pages: 3 schema: $ref: '#/components/schemas/RealmListContainer' 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 realm. _Check the response section for applicable examples (if any)._**' operationId: createRealm parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/Realm' type: object description: Input representation of user realm. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Realm' 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/realms/{objectId}: delete: deprecated: false description: '**Delete the realm associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteRealm parameters: - description: Unique identifier of the 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/Realm' 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 realm associated with the specified ID.**' operationId: getRealm parameters: - description: Unique identifier of the realm. 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/realms/RealmUUID ( Get Realm by id )': value: activeAuthSessionTimeout: 5 adJoinPassword: '********' adJoinUsername: administrator@ntd-test.cisco.com adPrimaryDomain: ntd-test.cisco.com baseDn: dc=ntd-test,dc=cisco,dc=com description: ntd-test domain dirPassword: '*******' dirUsername: administrator@ntd-test.cisco.com directoryConfigurations: - encryptionCert: id: fd01c1ca-9700-11ea-9f57-f3f11d78105e name: WIN2012-AD1.ntd-test.cisco.com_cert type: PKI_ExternalCA encryptionProtocol: LDAPS hostname: WIN2012-AD1.ntd-test.cisco.com id: 1 interface: id: bf9be468-9620-11ea-8b38-f1d4b3e2e3ba name: myIntZone type: InterfaceGroup port: 636 useRoutingToSelectInterface: false enabled: true excludedGroups: [] excludedUsers: - u64k_1 failedAuthSessionTimeout: 1440 groupAttribute: member groupDn: dc=ntd-test,dc=cisco,dc=com guestSessionTimeout: 1440 id: 625d610e-961c-11ea-83e4-8edad9fcf62e includedGroups: - G3K_1 - G3K_2 includedUsers: [] links: self: /fmc_config/v1/domain/domainUUID/object/realms/RealmUUID metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain duplicatedDomain: false hasUnresolvedReferences: false isDownloading: false readOnly: reason: SYSTEM state: true systemDefined: true name: ntd-test.cisco.com realm_id: 2 realmType: AD tsAgentSessionTimeout: 1440 type: Realm updateHour: 0 updateInterval: 24 version: '1' schema: $ref: '#/components/schemas/Realm' 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 realm associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateRealm parameters: - description: Unique identifier of the realm. in: path name: objectId required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/Realm' type: object description: Input representation of user realm. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Realm' 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/realms/operational/download: post: deprecated: false description: '**Download users and groups of the specified SAML realm. _Check the response section for applicable examples (if any)._**' operationId: createRealmDownload parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/realms/operational/download ( Download users and groups for specific SAML realm )' : value: realm: id: 8c67caeb-e5f4-4ae0-be47-fbb739939768 type: Realm type: RealmDownload schema: $ref: '#/components/schemas/RealmDownload' type: object description: Input representation of realm download object. required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/realms/operational/download ( Download users and groups for specific SAML realm )' : value: {} schema: $ref: '#/components/schemas/RealmDownload' 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/realmusergroups: get: deprecated: false description: '**Get the list of all realm user groups.**' operationId: getAllRealmUserGroup parameters: - description: Filter criteria can be specified using the format name:name;realm:realm;userId:userId

name -- Name of the group to be queried starting with....
realm -- Realm uuid for the group.
userId -- Groups with the user id.
in: query name: filter required: false schema: type: string - description: Name or part of the name of the group. in: query name: name required: false schema: type: string - description: UUID of the realm user group. in: query name: realm required: false schema: type: string - description: Searches for realms containing the given userid. in: query name: userId 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/realmusergroups?limit=2 ( Get all paginated RealmUserGroup with limit set 2 )' : value: items: - id: '73' name: G3K_1 type: RealmUserGroup - id: '62' name: G3K_10 type: RealmUserGroup links: self: /fmc_config/v1/domain/domainUUID/object/realmusergroups?offset=0&limit=2 paging: count: 5 limit: 2 next: - /fmc_config/v1/domain/domainUUID/object/realmusergroups?offset=2&limit=2 - /fmc_config/v1/domain/domainUUID/object/realmusergroups?offset=4&limit=1 offset: 0 pages: 3 ? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/realmusergroups?limit=2&expanded=true ( Get all paginated application with limit set 2 )' : value: items: - id: '73' metadata: hasUnresolvedReferences: false lastUpdated: 1597708969.0 name: G3K_1 realm: id: 3a0c2c20-dc18-11ea-87dc-a4f73ca0df49 name: ntd-test.cisco.com type: Realm type: RealmUserGroup - id: '62' metadata: hasUnresolvedReferences: false lastUpdated: 1597708969.0 name: G3K_10 realm: id: 3a0c2c20-dc18-11ea-87dc-a4f73ca0df49 name: ntd-test.cisco.com type: Realm type: RealmUserGroup links: self: /fmc_config/v1/domain/domainUUID/object/realmusergroups?offset=0&limit=5 paging: count: 5 limit: 2 next: - /fmc_config/v1/domain/domainUUID/object/realmusergroups?offset=2&limit=2 - /fmc_config/v1/domain/domainUUID/object/realmusergroups?offset=4&limit=1 offset: 0 pages: 3 schema: $ref: '#/components/schemas/RealmUserGroupListContainer' 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/realmusergroups/{objectId}: get: deprecated: false description: '**Get the realm user group associated with the specified ID.**' operationId: getRealmUserGroup parameters: - description: Unique identifier of the realm user group. 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/realmusergroups/4 ( Get RealmUserGroup by id )': value: id: '73' metadata: hasUnresolvedReferences: false lastUpdated: 1597708969.0 name: G3K_1 realm: id: 3a0c2c20-dc18-11ea-87dc-a4f73ca0df49 name: ntd-test.cisco.com type: Realm type: RealmUserGroup schema: $ref: '#/components/schemas/RealmUserGroup' 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/realmusers: get: deprecated: false description: '**Get the list of all realm users.**' operationId: getAllRealmUser parameters: - description: Filter criteria can be specified using the format name:name;realm:realm;groupId:groupId;resolved:resolved

name -- Name of the user to be queried starting with...
realm -- Realm uuid for the user.
groupId -- Users with the group id.
resolved -- Either true or false.
in: query name: filter required: false schema: type: string - description: Name or part of the name of the user. in: query name: name required: false schema: type: string - description: Realm uuid for the user. in: query name: realm required: false schema: type: string - description: Either true or false. in: query name: resolved required: false schema: type: string - description: Users with the group id. in: query name: groupId 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/realmusers?limit=2 ( Get all paginated Realm with limit set 2 )': value: items: - id: '4' name: u64k_11 type: RealmUser - id: '5' name: u64k_12 type: RealmUser links: self: /fmc_config/v1/domain/domainUUID/object/realmusers?offset=0&limit=2 paging: count: 5 limit: 2 next: - /fmc_config/v1/domain/domainUUID/object/realmusers?offset=2&limit=2 - /fmc_config/v1/domain/domainUUID/object/realmusers?offset=4&limit=1 offset: 0 pages: 3 ? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/realmusers?limit=2&expanded=true ( Get all paginated application with limit set 2 )' : value: items: - id: '4' metadata: lastSeen: 0 lastUpdated: 1597708969.0 resolved: true name: u64k_11 realm: id: 3a0c2c20-dc18-11ea-87dc-a4f73ca0df49 name: ntd-test.cisco.com type: Realm type: RealmUser - id: '5' metadata: lastSeen: 0 lastUpdated: 1597708969.0 resolved: true name: u64k_12 realm: id: 3a0c2c20-dc18-11ea-87dc-a4f73ca0df49 name: ntd-test.cisco.com type: Realm type: RealmUser links: self: /fmc_config/v1/domain/domainUUID/object/realmusers?offset=0&limit=5 paging: count: 5 limit: 2 next: - /fmc_config/v1/domain/domainUUID/object/realmusers?offset=2&limit=2 - /fmc_config/v1/domain/domainUUID/object/realmusers?offset=4&limit=1 offset: 0 pages: 3 schema: $ref: '#/components/schemas/RealmUserListContainer' 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/realmusers/{objectId}: get: deprecated: false description: '**Get the realm user associated with the specified ID.**' operationId: getRealmUser parameters: - description: Unique identifier of the 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/realmusers/4 ( Get RealmUser by id )': value: id: '4' metadata: lastSeen: 0 lastUpdated: 1597708969.0 resolved: true name: u64k_11 realm: id: 3a0c2c20-dc18-11ea-87dc-a4f73ca0df49 name: ntd-test.cisco.com type: Realm type: RealmUser schema: $ref: '#/components/schemas/RealmUser' 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/resourceprofiles: get: deprecated: false description: '**Get the list of all resource profiles.**' operationId: getAllResourceProfile 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 : GETALL /api/fmc_config/v1/domain/DomainUUID/object/resourceprofiles/ObjectUUID ( Success: Test GETALL method for ResourceProfile )' : value: items: - description: 'new description ' id: ObjectUUID links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/object/resourceprofiles/ResourceProfileUUID metadata: domain: id: DomainUUID name: Global type: Domain lastUser: name: rest timestamp: 1639522082400.0 name: RP14 numOfCPUs: 10 type: ResourceProfile links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/object/resourceprofiles?offset=0&limit=25&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GETALL /api/fmc_config/v1/domain/DomainUUID/object/resourceprofiles/ObjectUUID ( Success: Test GETALL method for ResourceProfile )' : value: items: - description: 'new description ' id: ObjectUUID links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/object/resourceprofiles/ResourceProfileUUID metadata: domain: id: DomainUUID name: Global type: Domain lastUser: name: rest timestamp: 1639522082400.0 name: RP14 numOfCPUs: 10 type: ResourceProfile links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/object/resourceprofiles?offset=0&limit=25&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/ResourceProfileListContainer' 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 resource profile. _Check the response section for applicable examples (if any)._**' operationId: createResourceProfile 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/resourceprofiles ( POST operstion to create new ResourceProfile object )' : value: name: resourceProfile_obj1 numOfCPUs: 4 type: ResourceProfile schema: $ref: '#/components/schemas/ResourceProfile' type: object description: Input representation of ResourceProfile object. required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST ​/api​/fmc_config/v1/domain/DomainUUID/object/resourceprofiles ( POST operstion to create new ResourceProfile object )' : value: description: ' ' id: ObjectUUID links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/object/resourceprofiles/ObjectUUID metadata: domain: id: DomainUUID name: Global type: Domain lastUser: name: rest timestamp: 0 name: resourceProfile_obj1 numOfCPUs: 4 type: ResourceProfile schema: $ref: '#/components/schemas/ResourceProfile' 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/resourceprofiles/{objectId}: delete: deprecated: false description: '**Delete the resource profile associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteResourceProfile parameters: - description: Unique identifier of the resource profile. 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/resourceprofiles ( DELETE operstion to create new ResourceProfile object )' : value: description: ' ' id: ObjectUUID links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/object/resourceprofiles/ObjectUUID metadata: domain: id: DomainUUID name: Global type: Domain lastUser: name: rest timestamp: 0 name: resourceProfile_obj1 numOfCPUs: 4 type: ResourceProfile schema: $ref: '#/components/schemas/ResourceProfile' 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 resource profile associated with the specified ID.**' operationId: getResourceProfile parameters: - description: Unique identifier of the resource profile. 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 : GETALL /api/fmc_config/v1/domain/DomainUUID/object/resourceprofiles/ObjectUUID ( Success: Test GETALL method for ResourceProfile )' : value: items: - description: 'new description ' id: ObjectUUID links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/object/resourceprofiles/ResourceProfileUUID metadata: domain: id: DomainUUID name: Global type: Domain lastUser: name: rest timestamp: 1639522082400.0 name: RP14 numOfCPUs: 10 type: ResourceProfile links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/object/resourceprofiles?offset=0&limit=25&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/object/resourceprofiles/ObjectUUID ( Success: Test GET method for ResourceProfile object )' : value: description: '' id: ObjectUUID metadata: domain: id: DomainUUID name: Global type: Domain lastUser: name: admin timestamp: 0 name: ResourceProfile_obj1 numOfCPUs: 4 type: ResourceProfile schema: $ref: '#/components/schemas/ResourceProfile' 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 resource profile associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateResourceProfile parameters: - description: Unique identifier of the resource profile. 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/resourceprofiles/ResourceProfileUUID ( PUT operstion to create new ResourceProfile object )' : value: id: ResourceProfileUUID name: resourceProfile_obj1 numOfCPUs: 4 type: ResourceProfile schema: $ref: '#/components/schemas/ResourceProfile' type: object description: Input representation of ResourceProfile object. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT ​/api​/fmc_config/v1/domain/DomainUUID/object/resourceprofiles/ResourceProfileUUID ( PUT operstion to create new ResourceProfile object )' : value: description: 'new description ' id: ResourceProfileUUID links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/object/resourceprofiles/0050568A-ABC0-0ed3-0000-322122547274 metadata: domain: id: DomainUUID name: Global type: Domain lastUser: name: rest timestamp: 0 name: resourceProfile_obj1 numOfCPUs: 4 type: ResourceProfile schema: $ref: '#/components/schemas/ResourceProfile' 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/routemaps: get: deprecated: false description: '**Get the list of all route maps.**' operationId: getAllRouteMap 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/routemaps ( Get all paginated route map objects )': value: items: - id: routemap-UUID1 links: self: https://fmc-host:port/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/routemaps/routemap-UUID1 name: test type: RouteMap - id: routemap-UUID2 links: self: https://fmc-host:port/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/routemaps/routemap-UUID2 name: testRMO type: RouteMap links: self: https://fmc-host:port/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/routemaps?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/RouteMapListContainer' 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 route map. _Check the response section for applicable examples (if any)._**' operationId: createRouteMap 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/routemaps ( POST to create a RouteMap object )': value: description: ' Created from REST' entries: - action: PERMIT asPathLists: - id: 00505686-A281-0ed3-0000-103079215107 name: '1' type: ASPathList extendedCommunityAdditive: true extendedCommunityLists: - id: 00505686-E294-0ed3-0000-008589934595 name: ABC type: ExtendedCommunityList extendedCommunityRouteTarget: 100:100 interfaces: - id: a01a5116-d8fc-11e8-80ae-af460801fbe6 name: outside type: SecurityZone ipv4AccessListAddresses: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList ipv4AccessListNextHops: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList ipv4AccessListRouteSources: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList ipv6AccessListAddresses: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList ipv6AccessListNextHops: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList ipv6AccessListRouteSources: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList metricRouteValues: - 11 routeTypeLocal: true sequence: 0 tagValues: - 123 name: test overridable: false type: RouteMap schema: $ref: '#/components/schemas/RouteMap' type: object description: Input representation of RouteMap object. required: true responses: '201': content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/routemaps ( POST to create a RouteMap object )': value: description: ' Created from REST' entries: - action: PERMIT asPathLists: - id: 00505686-A281-0ed3-0000-103079215107 name: '1' type: ASPathList extendedCommunityAdditive: true extendedCommunityLists: - id: 00505686-E294-0ed3-0000-008589934595 name: ABC type: ExtendedCommunityList - id: 00505686-E294-0ed3-0000-008589934598 name: ABC_123 type: ExtendedCommunityList extendedCommunityRouteTarget: 100:100,110:200,15:156 interfaces: - id: a01a5116-d8fc-11e8-80ae-af460801fbe6 name: outside type: SecurityZone ipv4AccessListAddresses: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList ipv4AccessListNextHops: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList ipv4AccessListRouteSources: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList ipv6AccessListAddresses: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList ipv6AccessListNextHops: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList ipv6AccessListRouteSources: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList metricRouteValues: - 11 routeTypeLocal: true sequence: 0 tagValues: - 123 id: new-routemap-UUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/routemaps/new-routemap-UUID metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global lastUser: name: admin timestamp: 1541617791486.0 name: test overridable: false type: RouteMap schema: $ref: '#/components/schemas/RouteMap' 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/routemaps/{objectId}: delete: deprecated: false description: '**Delete the route map associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteRouteMap parameters: - description: Unique identifier of the route 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: schema: $ref: '#/components/schemas/RouteMap' 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 route map associated with the specified ID.**' operationId: getRouteMap parameters: - description: Unique identifier of the route 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/routemaps/RouteMapUUID ( GET a route map object for the given UUID )' : value: description: ' ' entries: - action: PERMIT asPathLists: - id: 00505686-A281-0ed3-0000-154618823076 name: '3' type: ASPathList - id: 00505686-A281-0ed3-0000-154618823057 name: '2' type: ASPathList - id: 00505686-A281-0ed3-0000-103079215107 name: '1' type: ASPathList communityLists: - id: 00505686-A281-0ed3-0000-103079215145 name: community123 type: ExpandedCommunityList extendedCommunityAdditive: true extendedCommunityLists: - id: 00505686-E294-0ed3-0000-008589934595 name: ABC type: ExtendedCommunityList - id: 00505686-E294-0ed3-0000-008589934598 name: ABC_123 type: ExtendedCommunityList extendedCommunityRouteTarget: 100:100 interfaceNames: - inside interfaces: - id: a01a5116-d8fc-11e8-80ae-af460801fbe6 name: outside type: SecurityZone ipv4AccessListAddresses: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList - id: 00505686-A281-0ed3-0000-154618823115 name: testACL1 type: StandardAccessList ipv4AccessListNextHops: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList ipv4AccessListRouteSources: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList ipv6AccessListAddresses: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList ipv6AccessListNextHops: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList ipv6AccessListRouteSources: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList metricRouteValues: - 123 nextHopIPV6Setting: USE_PEER_ADDRESS policyLists: - id: 00505686-A281-0ed3-0000-154618822876 name: PL1 type: PolicyList prefixListIPV4Setting: id: 00505686-A281-0ed3-0000-094489280576 name: ipv4PL type: PrefixListObject routeTypeExternal1: true routeTypeExternal2: true routeTypeLocal: true routeTypeNSSAExternal1: true routeTypeNSSAExternal2: true sequence: 1 tagValues: - 345 - action: DENY interfaces: - id: a01a5116-d8fc-11e8-80ae-af460801fbe6 name: abcd type: SecurityZone ipv6PrefixListAddresses: - id: 00505686-A281-0ed3-0000-188978561027 name: prefIPV6 type: IPV6PrefixList ipv6PrefixListNexthops: - id: 00505686-A281-0ed3-0000-188978561027 name: prefIPV6 type: IPV6PrefixList ipv6PrefixListRouteSources: - id: 00505686-A281-0ed3-0000-188978561027 name: prefIPV6 type: IPV6PrefixList sequence: 2 id: routemap-UUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/routemaps/routemap-UUID metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global lastUser: name: admin timestamp: 1541648122323.0 name: testRMO overridable: false type: RouteMap schema: $ref: '#/components/schemas/RouteMap' 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 route map associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateRouteMap parameters: - description: Unique identifier of the route 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/routemaps/RouteMap-UUID ( PUT to update a Route map object )': value: description: ' Created from REST' entries: - action: PERMIT asPathLists: - id: 00505686-A281-0ed3-0000-103079215107 name: '1' type: ASPathList extendedCommunityAdditive: true extendedCommunityLists: - id: 00505686-E294-0ed3-0000-008589934595 name: ABC type: ExtendedCommunityList extendedCommunityRouteTarget: 100:100 interfaces: - id: a01a5116-d8fc-11e8-80ae-af460801fbe6 name: outside type: SecurityZone ipv4AccessListAddresses: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList ipv4AccessListNextHops: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList ipv4AccessListRouteSources: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList ipv6AccessListAddresses: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList ipv6AccessListNextHops: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList ipv6AccessListRouteSources: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList metricRouteValues: - 11 routeTypeLocal: true sequence: 0 tagValues: - 123 id: routemap-UUID name: test overridable: false type: RouteMap schema: $ref: '#/components/schemas/RouteMap' type: object description: Input representation of RouteMap object. required: true responses: '200': content: application/json: examples: 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/routemaps/RouteMap-UUID ( PUT to update a Route map object )': value: description: ' Created from REST' entries: - action: PERMIT asPathLists: - id: 00505686-A281-0ed3-0000-103079215107 name: '1' type: ASPathList extendedCommunityAdditive: true extendedCommunityLists: - id: 00505686-E294-0ed3-0000-008589934595 name: ABC type: ExtendedCommunityList extendedCommunityRouteTarget: 100:100 interfaces: - id: a01a5116-d8fc-11e8-80ae-af460801fbe6 name: outside type: SecurityZone ipv4AccessListAddresses: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList ipv4AccessListNextHops: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList ipv4AccessListRouteSources: - id: 00505686-A281-0ed3-0000-094489280517 name: testSACL type: StandardAccessList ipv6AccessListAddresses: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList ipv6AccessListNextHops: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList ipv6AccessListRouteSources: - id: 00505686-A281-0ed3-0000-094489280558 name: extACL type: ExtendedAccessList metricRouteValues: - 11 routeTypeLocal: true sequence: 0 tagValues: - 123 id: Routemap-UUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/routemaps/Routemap-UUID metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global lastUser: name: admin timestamp: 1541617791486.0 name: test overridable: false type: RouteMap schema: $ref: '#/components/schemas/RouteMap' 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/samlrealmusersandgroups: get: deprecated: false description: '**Get users and groups associated with the Azure AD realm specified in the parameters.**' operationId: getAllAzureADUserOrGroup parameters: - description: Filter criteria can be specified using the format name:name;realm:realm;

name -- Name of the user to be queried starting with...
realm -- Realm uuid for the user.
in: query name: filter required: false schema: type: string - description: Name or part of the name of the user or group. in: query name: name required: false schema: type: string - description: Required parameter. Realm uuid for the users and groups. in: query name: realm 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/AzureADUserOrGroupListContainer' 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/secureclientcustomizations: get: deprecated: false description: '**Get the list of all AnyConnect Customization objects.**' operationId: getAllSecureClientCustomizationModel 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/secureclientcustomizations?limit=1 ( Get all paginated secure client customization objects with limit=1 )' : value: items: - customizationType: LANGUAGE_LOCALIZATION description: Test-Language-JP fileName: language-jp.po id: 00505681-1EBF-0ed3-0000-523986010132 language: jp metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 1637140503020.0 name: Test-Language-JP type: SecureClientCustomization - customizationType: IMAGE description: Test-Icon-About-Desc fileName: about.png id: 00505681-1EBF-0ed3-0000-554050781239 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 1637063228973.0 name: Test-Icon-About operatingSystem: MAC type: SecureClientCustomization - customizationType: SCRIPT description: Test-scipt-mount-drive-desc fileName: onConnect_mount_drive.pl id: 00505681-1EBF-0ed3-0000-474050781256 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 1637063228973.0 name: Test-scipt-mount-drive operatingSystem: WINDOWS scriptType: ON_CONNECT type: SecureClientCustomization links: self: https:///api/fmc_config/v1/domain/{domainUUID}/object/secureclientcustomizations?offset=0&limit=1 paging: count: 3 limit: 20 offset: 0 pages: 1 schema: $ref: '#/components/schemas/SecureClientCustomizationModelListContainer' 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 Customization object. _Check the response section for applicable examples (if any)._**' operationId: createSecureClientCustomizationModel parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: multipart/form-data: schema: properties: customizationType: description: Customization type. [LANGUAGE_LOCALIZATION, IMAGE, SCRIPT, BINARY, CUSTOMIZED_INSTALLER_TRANSFORM, LOCALIZED_INSTALLER_TRANSFORM]. *required. type: string description: description: Provided resource description. type: string language: description: Language code. Applicable only when customization is of type LANGUAGE_LOCALIZATION/LOCALIZED_INSTALLER_TRANSFORM. type: string name: description: Provided resource name. *required type: string operatingSystem: description: Operating System. [WINDOWS, LINUX, MAC]. Applicable only when customization is of type IMAGE/SCRIPT/BINARY/CUSTOMIZED_INSTALLER_TRANSFORM. type: string payloadFile: description: Select an Secure Client Customization file. format: binary type: string scriptType: description: Script Type. [ON_CONNECT, ON_DISCONNECT]. Applicable only when customization is of type SCRIPT. type: string type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/SecureClientCustomizationModel' 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/secureclientcustomizations/{objectId}: delete: deprecated: false description: '**Delete the AnyConnect Customization object associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteSecureClientCustomizationModel parameters: - description: Unique identifier of the AnyConnect Customization 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 /fmc_config/v1/domain/DomainUUID/object/secureclientcustomizations/objectId ( DELETE operation for secure client customization )' : value: customizationType: LANGUAGE_LOCALIZATION description: Test-Language-JP fileName: language-jp.po id: 00505681-1EBF-0ed3-0000-523986010132 language: jp metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 1637140503020.0 name: Test-Language-JP type: SecureClientCustomization schema: $ref: '#/components/schemas/SecureClientCustomizationModel' 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 Customization object associated with the specified ID.**' operationId: getSecureClientCustomizationModel parameters: - description: Unique identifier of the AnyConnect Customization object. 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/secureclientcustomizations/objectId ( Get secure client customization for particular object ID )' : value: customizationType: LANGUAGE_LOCALIZATION description: Test-Language-JP fileName: language-jp.po id: 00505681-1EBF-0ed3-0000-523986010132 language: jp links: self: https:///api/fmc_config/v1/domain/{domainUUID}/object/secureclientcustomizations/{objectId} metadata: domain: id: string name: Test-Language-JP type: SecureClientCustomization schema: $ref: '#/components/schemas/SecureClientCustomizationModel' 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 Customization object associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateSecureClientCustomizationModel parameters: - description: Unique identifier of the AnyConnect Customization object. 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/secureclientcustomizations/secureclientcustomizationUUID ( Success: Test PUT method for secure client customization language )' : value: customizationType: LANGUAGE_LOCALIZATION description: Test-Language-JP fileName: language-jp.po language: jp name: Test-Language-JP type: SecureClientCustomization schema: properties: customizationType: description: Customization type. [LANGUAGE_LOCALIZATION, IMAGE, SCRIPT, BINARY, CUSTOMIZED_INSTALLER_TRANSFORM, LOCALIZED_INSTALLER_TRANSFORM]. *required. type: string description: description: Provided resource description. type: string id: description: Unique identifier of the AnyConnect Customization object. type: string language: description: Language code. Applicable only when customization is of type LANGUAGE_LOCALIZATION/LOCALIZED_INSTALLER_TRANSFORM. type: string name: description: Provided resource name. *required type: string operatingSystem: description: Operating System. [WINDOWS, LINUX, MAC]. Applicable only when customization is of type IMAGE/SCRIPT/BINARY/CUSTOMIZED_INSTALLER_TRANSFORM. type: string payloadFile: description: Select an Secure Client Customization file. format: binary type: string scriptType: description: Script Type. [ON_CONNECT, ON_DISCONNECT]. Applicable only when customization is of type SCRIPT. type: string type: object responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/secureclientcustomizations/secureclientcustomizationUUID ( Success: Test PUT method for secure client customization language )' : value: customizationType: LANGUAGE_LOCALIZATION description: Test-Language-JP fileName: language-jp.po id: 00505681-1EBF-0ed3-0000-523986010132 language: jp metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 1637140503020.0 name: Test-Language-JP type: SecureClientCustomization schema: $ref: '#/components/schemas/SecureClientCustomizationModel' 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/securitygrouptags: get: deprecated: false description: '**Get the list of all custom security group tags.**' operationId: getAllSecurityGroupTag 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/securitygrouptags ( Success: Test GET ALL success of all Security Group Tags )' : value: items: - id: examplesgtuuid links: self: /fmc_config/v1/domain/exampledomainuuid/object/securitygrouptags/examplesgtuuid name: ExampleSGTname type: SecurityGroupTag - id: examplesgtuuid2 links: self: /fmc_config/v1/domain/exampledomainuuid/object/securitygrouptags/examplesgtuuid2 name: ExampleSGTname2 type: SecurityGroupTag links: self: /fmc_config/v1/domain/exampledomainuuid/object/securitygrouptags?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/exampledomainuuid/object/securitygrouptags?expanded=true ( Success: Test GET ALL success with expanded=true )' : value: items: - description: example description. id: examplesgtuuid links: self: /fmc_config/v1/domain/exampledomainuuid/object/securitygrouptags/examplesgtuuid name: ExampleSGTname tag: 0 type: SecurityGroupTag - description: example description.2 id: examplesgtuuid2 links: self: /fmc_config/v1/domain/exampledomainuuid/object/securitygrouptags/examplesgtuuid2 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: ExampleSGTname2 tag: 0 type: SecurityGroupTag links: self: /fmc_config/v1/domain/exampledomainuuid/object/securitygrouptags?expanded=true paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/SecurityGroupTagListContainer' 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 group tag. _Check the response section for applicable examples (if any)._**' operationId: createSecurityGroupTag parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/exampledomainuuid/object/securitygrouptags ( Success: Test POST success a Security Group Tag )' : value: description: SGT description name: ExampleSGTname tag: 23 schema: $ref: '#/components/schemas/SecurityGroupTag' type: object description: The input security group tag model. required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/exampledomainuuid/object/securitygrouptags ( Success: Test POST success a Security Group Tag )' : value: description: SGT description id: f34bb568-e72c-11ec-8d8c-f86b0b566273 links: self: https://u45c01p14-vrouter.cisco.com:28426/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/securitygrouptags/f34bb568-e72c-11ec-8d8c-f86b0b566273 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: User readOnly: state: false timestamp: 1654694078.0 name: ExampleSGTname tag: 23 type: SecurityGroupTag schema: $ref: '#/components/schemas/SecurityGroupTag' 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/securitygrouptags/{objectId}: delete: deprecated: false description: '**Delete the custom security group tag associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteSecurityGroupTag parameters: - description: Unique identifier of the custom security group tag. 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/exampledomainuuid/object/securitygrouptags ( Success: Test PUT success a Security Group Tag )' : value: description: SGT description id: f34bb568-e72c-11ec-8d8c-f86b0b566273 links: self: https://u45c01p14-vrouter.cisco.com:28426/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/securitygrouptags/f34bb568-e72c-11ec-8d8c-f86b0b566273 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: User readOnly: state: false timestamp: 1654694078.0 name: NewExampleSGTname tag: 25 type: SecurityGroupTag schema: $ref: '#/components/schemas/SecurityGroupTag' 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 group tag associated with the specified ID.**' operationId: getSecurityGroupTag parameters: - description: Unique identifier of the custom 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/SecurityGroupTag' 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 group tag associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateSecurityGroupTag parameters: - description: Unique identifier of the custom security group tag. 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/exampledomainuuid/object/securitygrouptags ( Success: Test PUT success a Security Group Tag )' : value: description: SGT description id: f34bb568-e72c-11ec-8d8c-f86b0b566273 name: NewExampleSGTname tag: 25 schema: $ref: '#/components/schemas/SecurityGroupTag' type: object description: The input security group tag model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/exampledomainuuid/object/securitygrouptags ( Success: Test PUT success a Security Group Tag )' : value: description: SGT description id: f34bb568-e72c-11ec-8d8c-f86b0b566273 links: self: https://u45c01p14-vrouter.cisco.com:28426/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/securitygrouptags/f34bb568-e72c-11ec-8d8c-f86b0b566273 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: User readOnly: state: false timestamp: 1654694078.0 name: NewExampleSGTname tag: 25 type: SecurityGroupTag schema: $ref: '#/components/schemas/SecurityGroupTag' 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/securityzones: get: deprecated: false description: '**Get the list of all security zones.**' operationId: getAllSecurityZoneObject parameters: - description: Specify the desired InterfaceMore. Value is of format interfaceMode:ROUTED or interfaceMode:PASSIVE or interfaceMode:INLINE or interfaceMode:SWITCHED or interfaceMode:ASA. 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/securityzones ( Get all paginated securityzone objects )': value: items: - id: Sec-zone-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/securityzones/Sec-zone-UUID-2 name: Test2 type: SecurityZone - id: Sec-zone-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/securityzones/Sec-zone-UUID-3 name: Test1 type: SecurityZone links: self: https://example.cisco.com/api/fmc_config/v1/domain/default/object/securityzones?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/securityzones?expanded=true ( Get all paginated securityzone objects expanded=true )' : value: items: - id: Sec-zone-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://example.cisco.com/api/fmc_config/v1/domain/default/object/securityzones/Sec-zone-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: SecurityZone - id: Sec-zone-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://example.cisco.com/api/fmc_config/v1/domain/default/object/securityzones/Sec-zone-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: SecurityZone links: self: https://example.cisco.com/api/fmc_config/v1/domain/default/object/securityzones?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/SecurityZoneObjectListContainer' 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 security zone. _Check the response section for applicable examples (if any)._**' operationId: createMultipleSecurityZoneObject 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/securityzones ( POST method for security zone object )': value: interfaceMode: INLINE interfaces: - id: Intf-UUID-1 name: eth1 type: PhysicalInterface - id: Intf-UUID-2 name: eth2 type: PhysicalInterface name: SecurityZoneObject5 type: SecurityZone 'Example 2 : POST /fmc_config/v1/domain/domainUUID/object/securityzones?bulk=true ( bulk POST method for security zones )': value: - interfaceMode: ROUTED interfaces: - id: Intf-UUID-1 name: eth1 type: PhysicalInterface - id: Intf-UUID-2 name: eth2 type: PhysicalInterface name: SZ1 type: SecurityZone - interfaceMode: ROUTED interfaces: - id: Intf-UUID-3 name: eth3 type: PhysicalInterface - id: Intf-UUID-4 name: eth4 type: PhysicalInterface name: SZ2 type: SecurityZone schema: $ref: '#/components/schemas/SecurityZoneObject' type: object description: The input security zone object model. required: true responses: '201': content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/domainUUID/object/securityzones ( POST method for security zone object )': value: id: Sec-zone-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/securityzones/Sec-zone-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: SecurityZoneObject5 type: SecurityZone 'Example 2 : POST /fmc_config/v1/domain/domainUUID/object/securityzones?bulk=true ( bulk POST method for security zones )': value: items: - id: SZ1_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/securityzones/SZ1_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: SZ1 type: SecurityZone - id: SZ2_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/securityzones/SZ2_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: SZ2 type: SecurityZone links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/securityzones?bulk=true schema: $ref: '#/components/schemas/SecurityZoneObject' 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/securityzones/{objectId}: delete: deprecated: false description: '**Delete the security zone associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteSecurityZoneObject parameters: - description: Unique identifier of the security zone. 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/securityzones/Sec-zone-UUID-1 ( DELETE method for security zone object )' : value: id: Sec-zone-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/securityzones/Sec-zone-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: SecurityZoneObject5 type: SecurityZone schema: $ref: '#/components/schemas/SecurityZoneObject' 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 security zone associated with the specified ID.**' operationId: getSecurityZoneObject parameters: - description: Unique identifier of the security zone. in: path name: objectId required: true schema: type: string - description: Boolean indicating whether to group interfaces by device and return as devices attribute instead of 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/securityzones/Sec-zone-UUID-1 ( GET method for security zone object by UUID )' : value: id: Sec-zone-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/securityzones/Sec-zone-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: SecurityZoneObject5 type: SecurityZone schema: $ref: '#/components/schemas/SecurityZoneObject' 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 security zone associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateSecurityZoneObject parameters: - description: Unique identifier of the security zone. 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/securityzones/Sec-zone-UUID-1 ( PUT method for security zone object )' : value: id: Sec-zone-UUID-1 interfaceMode: INLINE interfaces: - id: Intf-UUID-1 name: eth1 type: FPPhysicalInterface name: SecurityZoneObject5 type: SecurityZone schema: $ref: '#/components/schemas/SecurityZoneObject' type: object description: The input security zone object model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/object/securityzones/Sec-zone-UUID-1 ( PUT method for security zone object )' : value: id: Sec-zone-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/securityzones/Sec-zone-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: SecurityZoneObject5 type: SecurityZone schema: $ref: '#/components/schemas/SecurityZoneObject' 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/serviceaccessobjects: get: deprecated: false description: '**Get the list of all service access objects.**' operationId: getAllServiceAccessObject 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/ServiceAccessObjectListContainer' 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 service access object. _Check the response section for applicable examples (if any)._**' operationId: createServiceAccessObject 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/ServiceAccessObject' type: object description: The input Service Access object model. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ServiceAccessObject' 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/serviceaccessobjects/{containerUUID}/overrides: get: deprecated: false description: '**Get all overrides on the specified service access object. Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored.**' operationId: getServiceAccessObjectOverride 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/ServiceAccessObjectOverrideListContainer' 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/serviceaccessobjects/{objectId}: delete: deprecated: false description: '**Delete the service access objection associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteServiceAccessObject parameters: - description: Unique identifier of the service access 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/ServiceAccessObject' 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 service access objection associated with the specified ID.**' operationId: getServiceAccessObject parameters: - description: Unique identifier of the service access object. in: path name: objectId required: true schema: type: string - description: Get the overrides associated with the specified service access 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: schema: $ref: '#/components/schemas/ServiceAccessObject' 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 service access objection associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateServiceAccessObject parameters: - description: Unique identifier of the service access 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: schema: $ref: '#/components/schemas/ServiceAccessObject' type: object description: The input Service Access object model. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceAccessObject' 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/sidnsfeeds: get: deprecated: false description: '**Get the list of all security intelligence DNS feeds.**' operationId: getAllSIDNSFeed 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/sidnsfeeds?expanded=false&limit=2 ( Get all paginated SIDNSFeeds with expanded set to false and limit set to 2 )' : value: items: - id: SIDNSFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds/SIDNSFeedId name: testing type: SIDNSFeed - id: SIDNSFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds/SIDNSFeedId name: testing2 type: SIDNSFeed links: self: /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds?expanded=false&offset=0&limit=2 paging: count: 27 limit: 2 next: - /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds?expanded=false&offset=2&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds?expanded=false&offset=4&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds?expanded=false&offset=6&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds?expanded=false&offset=8&limit=2 offset: 0 pages: 14 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds?expanded=true&limit=2 ( Get all paginated SIDNSFeeds with expanded set to true and limit set to 2 )' : value: items: - checksumURL: example1.com feedURL: example1.com id: SIDNSFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds/SIDNSFeedId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 4 lastUser: id: adminUUID name: admin type: user readOnly: state: false timestamp: 1605518859.0 name: testing type: SIDNSFeed updateFrequency: 60 - checksumURL: example2.com feedURL: example2.com id: SIDNSFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds/SIDNSFeedId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 7 lastUser: id: adminUUID name: admin type: user readOnly: state: false timestamp: 1605518859.0 name: testing2 type: SIDNSFeed updateFrequency: 120 links: self: /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds?expanded=true&offset=0&limit=2 paging: count: 27 limit: 2 next: - /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds?expanded=true&offset=2&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds?expanded=true&offset=4&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds?expanded=true&offset=6&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds?expanded=true&offset=8&limit=2 offset: 0 pages: 14 schema: $ref: '#/components/schemas/SIDNSFeedListContainer' 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/sidnsfeeds/{objectId}: get: deprecated: false description: '**Get the security intelligence DNS feed associated with the specified ID.**' operationId: getSIDNSFeed parameters: - description: Unique identifier of the security intelligence DNS feed. 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/sidnsfeeds/SIDNSFeedId ( Get SIDNSFeed by id )': value: checksumURL: example.com feedURL: example.com id: SIDNSFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sidnsfeeds/SIDNSFeedId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 4 lastUser: id: adminUUID name: admin type: user readOnly: state: false timestamp: 1605518859.0 name: DNSFeed type: SIDNSFeed updateFrequency: 60 schema: $ref: '#/components/schemas/SIDNSFeed' 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/sidnslists: get: deprecated: false description: '**Get the list of all security intelligence DNS lists.**' operationId: getAllSIDNSList 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/sidnslists?expanded=false&limit=2 ( Get all paginated SIDNSLists with expanded set to false and limit set to 2 )' : value: items: - id: SIDNSListId links: self: /fmc_config/v1/domain/DomainUUID/object/sidnslists/SIDNSListId name: testing type: SIDNSList - id: SIDNSListId links: self: /fmc_config/v1/domain/DomainUUID/object/sidnslists/SIDNSListId name: testing2 type: SIDNSList links: self: /fmc_config/v1/domain/DomainUUID/object/sidnslists?expanded=false&limit=2 paging: count: 27 limit: 2 next: - /fmc_config/v1/domain/DomainUUID/object/sidnslists?expanded=false&offset=2&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sidnslists?expanded=false&offset=4&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sidnslists?expanded=false&offset=6&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sidnslists?expanded=false&offset=8&limit=2 offset: 0 pages: 14 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/sidnslists?expanded=true&limit=2 ( Get all paginated SIDNSLists with expanded set to true and limit set to 2 )' : value: items: - fileName: fmc_ip_list1.txt id: SIDNSListId links: self: /fmc_config/v1/domain/DomainUUID/object/sidnslists/SIDNSListId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 4 lastUser: id: adminUUID name: admin type: user listUpdateTime: 1605518859.0 readOnly: state: false timestamp: 1605518859.0 name: testing type: SIDNSList - fileName: fmc_ip_list2.txt id: SIDNSListId links: self: /fmc_config/v1/domain/DomainUUID/object/sidnslists/SIDNSListId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 7 lastUser: id: adminUUID name: admin type: user listUpdateTime: 1605518859.0 readOnly: state: false timestamp: 1605518859.0 name: testing2 type: SIDNSList links: self: /fmc_config/v1/domain/DomainUUID/object/sidnslists?expanded=true&limit=2 paging: count: 27 limit: 2 next: - /fmc_config/v1/domain/DomainUUID/object/sidnslists?expanded=true&offset=2&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sidnslists?expanded=true&offset=4&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sidnslists?expanded=true&offset=6&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sidnslists?expanded=true&offset=8&limit=2 offset: 0 pages: 14 schema: $ref: '#/components/schemas/SIDNSListListContainer' 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/sidnslists/{objectId}: get: deprecated: false description: '**Get the security intelligence DNS list associated with the specified ID.**' operationId: getSIDNSList parameters: - description: Unique identifier of the security intelligence DNS 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/sidnslists/SIDNSListId ( Get SIDNSList by id )': value: fileName: fmc_ip_list.txt id: SIDNSListId links: self: /fmc_config/v1/domain/DomainUUID/object/sidnslists/SIDNSListId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 10 lastUpdateTime: 1605518890.0 lastUser: id: adminUUID name: admin type: user readOnly: state: false timestamp: 1605518890.0 name: DNSList type: SIDNSList schema: $ref: '#/components/schemas/SIDNSList' 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/sinetworkfeeds: get: deprecated: false description: '**Retrieving data. Wait a few seconds and try to cut or copy again.**' operationId: getAllSINetworkFeed 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/sinetworkfeeds?expanded=false&limit=2 ( Get all paginated SINetworkFeed with expanded set to false and limit set to 2 )' : value: items: - id: SINetworkFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds/SINetworkFeedId name: NetworkFeed1 type: SINetworkFeed - id: SINetworkFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds/SINetworkFeedId name: NetworkFeed2 type: SINetworkFeed links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=false&offset=0&limit=2 paging: count: 27 limit: 2 next: - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=false&offset=2&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=false&offset=4&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=false&offset=6&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=false&offset=8&limit=2 offset: 0 pages: 14 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=true&limit=2 ( Get all paginated SINetworkFeed with expanded set to true and limit set to 2 )' : value: items: - checksumURL: example1.com feedURL: example1.com id: SINetworkFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds/SINetworkFeedId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 4 feedUpdateTime: 1605518859.0 lastUser: id: adminUUID name: admin type: user readOnly: state: false timestamp: 1605518859.0 name: NetworkFeed1 type: SINetworkFeed updateFrequency: 60 - checksumURL: example2.com feedURL: example2.com id: SINetworkFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds/SINetworkFeedId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 7 feedUpdateTime: 1605518859.0 lastUser: id: adminUUID name: admin type: user readOnly: state: false timestamp: 1605518859.0 name: NetworkFeed2 type: SINetworkFeed updateFrequency: 120 links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=true&offset=0&limit=2 paging: count: 27 limit: 2 next: - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=true&offset=2&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=true&offset=4&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=true&offset=6&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=true&offset=8&limit=2 offset: 0 pages: 14 schema: $ref: '#/components/schemas/SINetworkFeedListContainer' 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 security intelligence network feed. _Check the response section for applicable examples (if any)._**' operationId: createSINetworkFeed parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds ( Create a SINetworkFeed object )': value: checksumURL: example1.com feedURL: example1.com name: NetworkFeed1 type: SINetworkFeed updateFrequency: 60 schema: $ref: '#/components/schemas/SINetworkFeed' type: object description: Input representation of Security Intelligence Network Feed object. required: true responses: '201': content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds ( Create a SINetworkFeed object )': value: checksumURL: example1.com feedURL: example1.com id: fc79ce12-069a-11ed-87bb-780a89d43a90 links: self: https://u45c01p14-vrouter.cisco.com:30814/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/sinetworkfeeds/fc79ce12-069a-11ed-87bb-780a89d43a90 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain entryCount: 1 feedUpdateTime: 1658149824.0 lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: user readOnly: state: false timestamp: 1658149824.0 name: NetworkFeed1 type: SINetworkFeed updateFrequency: 60 schema: $ref: '#/components/schemas/SINetworkFeed' 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/sinetworkfeeds/{objectId}: delete: deprecated: false description: '**Delete the security intelligence network feed associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteSINetworkFeed parameters: - description: Unique identifier of the security intelligence network feed. 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/sinetworkfeeds/fc79ce12-069a-11ed-87bb-780a89d43a90 ( Delete a SINetworkFeed object )' : value: checksumURL: example2.com feedURL: example2.com id: fc79ce12-069a-11ed-87bb-780a89d43a90 links: self: https://u45c01p14-vrouter.cisco.com:30814/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/sinetworkfeeds/fc79ce12-069a-11ed-87bb-780a89d43a90 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain entryCount: 6 feedUpdateTime: 1658149824.0 lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: user readOnly: state: false timestamp: 1658149824.0 name: NetworkFeed1_Edited type: SINetworkFeed updateFrequency: 120 schema: $ref: '#/components/schemas/SINetworkFeed' 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 security intelligence network feed associated with the specified ID.**' operationId: getSINetworkFeed parameters: - description: Unique identifier of the security intelligence network feed. 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/sinetworkfeeds/SINetworkFeedId ( Get SINetworkFeed by id )': value: checksumURL: example1.com feedURL: example1.com id: SINetworkFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds/SINetworkFeedId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 4 feedUpdateTime: 1605518859.0 lastUser: id: adminUUID name: admin type: user readOnly: state: false timestamp: 1605518859.0 name: NetworkFeed type: SINetworkFeed updateFrequency: 60 schema: $ref: '#/components/schemas/SINetworkFeed' 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 security intelligence network feed associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateSINetworkFeed parameters: - description: Unique identifier of the security intelligence network feed. 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/sinetworkfeeds/fc79ce12-069a-11ed-87bb-780a89d43a90 ( Update a SINetworkFeed object )' : value: checksumURL: example2.com feedURL: example2.com id: fc79ce12-069a-11ed-87bb-780a89d43a90 name: NetworkFeed1_Edited type: SINetworkFeed updateFrequency: 120 schema: $ref: '#/components/schemas/SINetworkFeed' type: object description: Input representation of Security Intelligence Network Feed object. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds/fc79ce12-069a-11ed-87bb-780a89d43a90 ( Update a SINetworkFeed object )' : value: checksumURL: example2.com feedURL: example2.com id: fc79ce12-069a-11ed-87bb-780a89d43a90 links: self: https://u45c01p14-vrouter.cisco.com:30814/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/sinetworkfeeds/fc79ce12-069a-11ed-87bb-780a89d43a90 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain entryCount: 6 feedUpdateTime: 1658149824.0 lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: user readOnly: state: false timestamp: 1658149824.0 name: NetworkFeed1_Edited type: SINetworkFeed updateFrequency: 120 schema: $ref: '#/components/schemas/SINetworkFeed' 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/sinetworklists: get: deprecated: false description: '**Get the list of all security intelligence network lists.**' operationId: getAllSINetworkList 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/sinetworkfeeds?expanded=false&limit=2 ( Get all paginated SINetworkFeed with expanded set to false and limit set to 2 )' : value: items: - id: SINetworkFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds/SINetworkFeedId name: NetworkFeed1 type: SINetworkFeed - id: SINetworkFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds/SINetworkFeedId name: NetworkFeed2 type: SINetworkFeed links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=false&offset=0&limit=2 paging: count: 27 limit: 2 next: - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=false&offset=2&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=false&offset=4&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=false&offset=6&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=false&offset=8&limit=2 offset: 0 pages: 14 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=true&limit=2 ( Get all paginated SINetworkFeed with expanded set to true and limit set to 2 )' : value: items: - checksumURL: example1.com feedURL: example1.com id: SINetworkFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds/SINetworkFeedId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 4 feedUpdateTime: 1605518859.0 lastUser: id: adminUUID name: admin type: user readOnly: state: false timestamp: 1605518859.0 name: NetworkFeed1 type: SINetworkFeed updateFrequency: 60 - checksumURL: example2.com feedURL: example2.com id: SINetworkFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds/SINetworkFeedId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 7 feedUpdateTime: 1605518859.0 lastUser: id: adminUUID name: admin type: user readOnly: state: false timestamp: 1605518859.0 name: NetworkFeed2 type: SINetworkFeed updateFrequency: 120 links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=true&offset=0&limit=2 paging: count: 27 limit: 2 next: - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=true&offset=2&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=true&offset=4&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=true&offset=6&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds?expanded=true&offset=8&limit=2 offset: 0 pages: 14 schema: $ref: '#/components/schemas/SINetworkListListContainer' 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/sinetworklists/{objectId}: get: deprecated: false description: '**Get the security intelligence network list associated with the specified ID.**' operationId: getSINetworkList parameters: - description: Unique identifier of the 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/sinetworkfeeds/SINetworkFeedId ( Get SINetworkFeed by id )': value: checksumURL: example1.com feedURL: example1.com id: SINetworkFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworkfeeds/SINetworkFeedId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 4 feedUpdateTime: 1605518859.0 lastUser: id: adminUUID name: admin type: user readOnly: state: false timestamp: 1605518859.0 name: NetworkFeed type: SINetworkFeed updateFrequency: 60 schema: $ref: '#/components/schemas/SINetworkList' 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/sinkholes: get: deprecated: false description: '**Get the list of all sinkholes.**' operationId: getAllSinkhole 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/sinkholes?limit=2&expanded=true ( Get all paginated Sinkhole objects with limit set to 2 )' : value: items: - action: MONITOR id: SinkholeId ipv4: 127.0.0.1 ipv6: ::1 links: self: /fmc_config/v1/domain/DomainUUID/object/sinkholes/SinkholeId name: testing sinkholeType: SINKHOLE_MALWARE type: Sinkhole - action: BLOCK id: SinkholeId ipv4: 127.0.0.1 ipv6: ::1 links: self: /fmc_config/v1/domain/DomainUUID/object/sinkholes/SinkholeId name: testing2 sinkholeType: SINKHOLE_PHISHING type: Sinkhole links: self: /fmc_config/v1/domain/DomainUUID/object/sinkholes?offset=0&limit=2 paging: count: 27 limit: 2 next: - /fmc_config/v1/domain/DomainUUID/object/sinkholes?offset=2&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinkholes?offset=4&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinkholes?offset=6&limit=2 - /fmc_config/v1/domain/DomainUUID/object/sinkholes?offset=8&limit=2 offset: 0 pages: 14 schema: $ref: '#/components/schemas/SinkholeListContainer' 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/sinkholes/{objectId}: get: deprecated: false description: '**Get the sinkhole associated with the specified ID.**' operationId: getSinkhole parameters: - description: Unique identifier of the sinkhole. 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/sinkholes/SinkholeId ( Get Sinkhole by id )': value: action: MONITOR id: SinkholeId ipv4: 127.0.0.1 ipv6: ::1 links: self: /fmc_config/v1/domain/DomainUUID/object/sinkholes/SinkholeId name: Sinkhole1 sinkholeType: SINKHOLE_CN_C type: Sinkhole schema: $ref: '#/components/schemas/Sinkhole' 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/siurlfeeds: get: deprecated: false description: '**Get the list of all security intelligence url feeds.**' operationId: getAllSIURLFeed 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/siurlfeeds?expanded=false&limit=2 ( Get all paginated SIURLFeed with expanded set to false and limit set to 2 )' : value: items: - id: SIURLFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/siurlfeeds/SIURLFeedId name: testing type: SIURLFeed - id: SIURLFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/siurlfeeds/SIURLFeedId name: testing2 type: SIURLFeed links: self: /fmc_config/v1/domain/DomainUUID/object/siurlfeeds?expanded=false&offset=0&limit=2 paging: count: 27 limit: 2 next: - /fmc_config/v1/domain/DomainUUID/object/siurlfeeds?expanded=false&offset=2&limit=2 - /fmc_config/v1/domain/DomainUUID/object/siurlfeeds?expanded=false&offset=4&limit=2 - /fmc_config/v1/domain/DomainUUID/object/siurlfeeds?expanded=false&offset=6&limit=2 - /fmc_config/v1/domain/DomainUUID/object/siurlfeeds?expanded=false&offset=8&limit=2 offset: 0 pages: 14 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/siurlfeeds?limit=2 ( Get all paginated SIURLFeed with expanded set to true and limit set to 2 )' : value: expectHeaderContains: - content-type: application/json expectJSONTypes: items: - checksumURL: string feedURL: string id: string links: self: string metadata: object name: string type: string updateFrequency: integer links: self: string paging: count: number limit: number offset: number pages: number expectStatus: 200 items: - checksumURL: example1.com feedURL: example1.com id: SIURLFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/siurlfeeds/SIURLFeedId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 4 feedUpdateTime: 1605518859.0 lastUser: id: adminUUID name: admin type: user readOnly: state: false timestamp: 1605518859.0 name: testing type: SIURLFeed updateFrequency: 60 - checksumURL: example2.com feedURL: example2.com id: SIURLFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/siurlfeeds/SIURLFeedId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 4 feedUpdateTime: 1605518859.0 lastUser: id: adminUUID name: admin type: user readOnly: state: false timestamp: 1605518859.0 name: testing2 type: SIURLFeed updateFrequency: 120 links: self: /fmc_config/v1/domain/DomainUUID/object/siurlfeeds?expanded=true&offset=0&limit=2 paging: count: 27 limit: 2 next: - /fmc_config/v1/domain/DomainUUID/object/siurlfeeds?expanded=true&offset=2&limit=2 - /fmc_config/v1/domain/DomainUUID/object/siurlfeeds?expanded=true&offset=4&limit=2 - /fmc_config/v1/domain/DomainUUID/object/siurlfeeds?expanded=true&offset=6&limit=2 - /fmc_config/v1/domain/DomainUUID/object/siurlfeeds?expanded=true&offset=8&limit=2 offset: 0 pages: 14 schema: $ref: '#/components/schemas/SIURLFeedListContainer' 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 security intelligence url feed. _Check the response section for applicable examples (if any)._**' operationId: createSIURLFeed parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/siurlfeeds ( Create a URL Feed object )': value: checksumURL: example1.com feedURL: example1.com name: URLFeed1 type: SIURLFeed updateFrequency: 60 schema: $ref: '#/components/schemas/SIURLFeed' type: object description: Representation of Security Intelligence URL Feed object. required: true responses: '201': content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/siurlfeeds ( Create a URL Feed object )': value: checksumURL: example1.com feedURL: example1.com id: fc79ce12-069a-11ed-87bb-780a89d43a90 links: self: https://u45c01p14-vrouter.cisco.com:30814/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/siurlfeeds/fc79ce12-069a-11ed-87bb-780a89d43a90 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain entryCount: 1 feedUpdateTime: 1658149824.0 lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: user readOnly: state: false timestamp: 1658149824.0 name: URLFeed1 type: SIURLFeed updateFrequency: 60 schema: $ref: '#/components/schemas/SIURLFeed' 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/siurlfeeds/{objectId}: delete: deprecated: false description: '**Delete the security intelligence url feed associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteSIURLFeed parameters: - description: Unique identifier of the security intelligence url feed. 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/siurlfeeds/fc79ce12-069a-11ed-87bb-780a89d43a90 ( Delete a URL Feed object )' : value: checksumURL: example2.com feedURL: example2.com id: fc79ce12-069a-11ed-87bb-780a89d43a90 links: self: https://u45c01p14-vrouter.cisco.com:30814/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/siurlfeeds/fc79ce12-069a-11ed-87bb-780a89d43a90 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain entryCount: 6 feedUpdateTime: 1658149824.0 lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: user readOnly: state: false timestamp: 1658149824.0 name: URLFeed1_Edited type: SIURLFeed updateFrequency: 120 schema: $ref: '#/components/schemas/SIURLFeed' 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 security intelligence url feed associated with the specified ID.**' operationId: getSIURLFeed parameters: - description: Unique identifier of the security intelligence url feed. 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/siurlfeeds/SIURLFeedId ( Get SIURLFeed by id )': value: checksumURL: example1.com feedURL: example1.com id: SIURLFeedId links: self: /fmc_config/v1/domain/DomainUUID/object/siurlfeeds/SIURLFeedId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 4 feedUpdateTime: 1605518859.0 lastUser: id: adminUUID name: admin type: user readOnly: state: false timestamp: 1605518859.0 name: URLFeed1 type: SIURLFeed updateFrequency: 60 schema: $ref: '#/components/schemas/SIURLFeed' 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 security intelligence url feed associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateSIURLFeed parameters: - description: Unique identifier of the security intelligence url feed. 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/siurlfeeds/fc79ce12-069a-11ed-87bb-780a89d43a90 ( Update a URL Feed object )' : value: checksumURL: example2.com feedURL: example2.com id: fc79ce12-069a-11ed-87bb-780a89d43a90 name: URLFeed1_Edited type: SIURLFeed updateFrequency: 120 schema: $ref: '#/components/schemas/SIURLFeed' type: object description: Representation of Security Intelligence URL Feed object. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/siurlfeeds/fc79ce12-069a-11ed-87bb-780a89d43a90 ( Update a URL Feed object )' : value: checksumURL: example2.com feedURL: example2.com id: fc79ce12-069a-11ed-87bb-780a89d43a90 links: self: https://u45c01p14-vrouter.cisco.com:30814/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/siurlfeeds/fc79ce12-069a-11ed-87bb-780a89d43a90 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain entryCount: 6 feedUpdateTime: 1658149824.0 lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: user readOnly: state: false timestamp: 1658149824.0 name: URLFeed1_Edited type: SIURLFeed updateFrequency: 120 schema: $ref: '#/components/schemas/SIURLFeed' 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/siurllists: get: deprecated: false description: '**Get the list of all security intelligence url lists.**' operationId: getAllSIURLList 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/siurllists?expanded=false&limit=2 ( Get all paginated URL Lists with expanded set to false and limit set to 2 )' : value: items: - id: SIURLListId links: self: /fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListId name: Descendant-Blocklists-for-URL - Global type: SIURLList - id: SIURLListId links: self: /fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListId name: Descendant-Do-Not-Block-Lists-for-URL - Global type: SIURLList links: self: /fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=false&offset=0&limit=2 paging: count: 27 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 - /fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=false&offset=6&limit=2 - /fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=false&offset=8&limit=2 offset: 0 pages: 14 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/siurllists?limit=2&expanded=true ( Get all paginated URL Lists with limit set to 2 )' : value: items: - fileName: fmc_ip_list1.txt id: SIURLListId links: self: /fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 4 lastUser: id: adminUUID name: admin type: user listUpdateTime: 1605518859.0 readOnly: state: false timestamp: 1605518859.0 name: Descendant-Blocklists-for-URL - Global type: SIURLList - fileName: fmc_ip_list2.txt id: SIURLListId links: self: /fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 12 lastUser: id: adminUUID name: admin type: user listUpdateTime: 1605518859.0 readOnly: state: false timestamp: 1605518859.0 name: Descendant-Do-Not-Block-Lists-for-URL - Global type: SIURLList links: self: /fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=true&offset=0&limit=2 paging: count: 27 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 - /fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=true&offset=6&limit=2 - /fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=true&offset=8&limit=2 offset: 0 pages: 14 schema: $ref: '#/components/schemas/SIURLListListContainer' 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 security intelligence url list. _Check the response section for applicable examples (if any)._**' operationId: createSIURLList parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/SIURLList' type: object description: Request input of Security Intelligence URL List object. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/SIURLList' 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/siurllists/{objectId}: delete: deprecated: false description: '**Delete the security intelligence url list associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteSIURLList parameters: - description: Unique identifier of the 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/siurllists/fc79ce12-069a-11ed-87bb-780a89d43a90 ( Delete a URL List object )' : value: fileName: urls.txt id: fc79ce12-069a-11ed-87bb-780a89d43a90 links: self: https://u45c01p14-vrouter.cisco.com:30814/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/siurllists/fc79ce12-069a-11ed-87bb-780a89d43a90 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain entryCount: 6 lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: user listUpdateTime: 1658149824.0 readOnly: state: false timestamp: 1658149824.0 name: List_1_Edited type: SIURLList schema: $ref: '#/components/schemas/SIURLList' 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 security intelligence url list associated with the specified ID.**' operationId: getSIURLList parameters: - description: Unique identifier of the 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/siurllists/SIURLListId ( Get URL List by id )': value: fileName: fmc_ip_list1.txt id: SIURLListId links: self: /fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListId metadata: domain: id: domainUUID name: Global type: Domain entryCount: 4 lastUser: id: adminUUID name: admin type: user listUpdateTime: 1605518859.0 readOnly: state: false timestamp: 1605518859.0 name: URL type: SIURLList schema: $ref: '#/components/schemas/SIURLList' 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 security intelligence url list associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateSIURLList parameters: - description: Unique identifier of the security intelligence url list. 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/siurllists/fc79ce12-069a-11ed-87bb-780a89d43a90 ( Modify a URL List object )' : value: fileName: urls.txt id: fc79ce12-069a-11ed-87bb-780a89d43a90 listType: 4 name: List_1_Edited type: SIURLList schema: $ref: '#/components/schemas/SIURLList' type: object description: Request input of Security Intelligence URL List object. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/siurllists/fc79ce12-069a-11ed-87bb-780a89d43a90 ( Modify a URL List object )' : value: fileName: urls.txt id: fc79ce12-069a-11ed-87bb-780a89d43a90 links: self: https://u45c01p14-vrouter.cisco.com:30814/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/siurllists/fc79ce12-069a-11ed-87bb-780a89d43a90 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain entryCount: 6 lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: user listUpdateTime: 1658149824.0 readOnly: state: false timestamp: 1658149824.0 name: List_1_Edited type: SIURLList schema: $ref: '#/components/schemas/SIURLList' 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/slamonitors: get: deprecated: false description: '**Get the list of all service level agreement monitors.**' operationId: getAllSLAMonitorObjectModel 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/slamonitors?limit=2 ( Get all paginated slamonitors objects with limit set 2 )' : value: items: - id: slaMonitorObjectUUID links: self: /fmc_config/v1/domain/DomainUUID/object/slamonitors/slaMonitorObjectUUID name: SLA1 - id: slaMonitorObject2UUID links: self: /fmc_config/v1/domain/DomainUUID/object/slamonitors/slaMonitorObject2UUID name: SLA2 links: self: /fmc_config/v1/domain/DomainUUID/object/slamonitors?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/slamonitors?limit=2&expanded=true ( Get all paginated sla monitor objects with limit set 2 )' : value: items: - dataSize: 28 description: Sla monitor description frequency: 60 id: slaMonitorObjectUUID interfaceNames: - Interface1 interfaceObjects: - id: securityZoneUUID name: SecZone1 type: SecurityZone - id: interfaceGroupUUID name: InterfaceGroup1 type: InterfaceGroup links: self: /fmc_config/v1/domain/DomainUUID/object/slamonitors/slaMonitorObjectUUID monitorAddress: 1.1.1.1 name: SLA1 noOfPackets: 1 slaId: 1 threshold: 2 timeout: 5000 tos: 1 type: SLAMonitor - dataSize: 50 description: sla monitor description frequency: 90 id: slaMonitorObject2UUID interfaceNames: - Interface2 interfaceObjects: - id: securityZoneUUID name: SecZone1 type: SecurityZone - id: interfaceGroupUUID name: InterfaceGroup2 type: InterfaceGroup links: self: /fmc_config/v1/domain/DomainUUID/object/countries/slaMonitorObject2UUID monitorAddress: 2.2.2.2 name: SLA2 noOfPackets: 1 slaId: 2 threshold: 5 timeout: 5000 tos: 2 type: SLAMonitor links: self: /fmc_config/v1/domain/DomainUUID/object/slamonitors?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/SLAMonitorObjectModelListContainer' 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 service level agreement monitor. _Check the response section for applicable examples (if any)._**' operationId: createMultipleSLAMonitorObjectModel 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/slamonitors ( POST method for SLA Monitor Object )': value: dataSize: 28 description: Sla monitor description frequency: 60 interfaceNames: - 'comment : interfaceNames are not allowed in POST. New Inline Interface Names can not be added via POST.' interfaceObjects: - id: securityZoneUUID name: SecZone1 type: SecurityZone - id: interfaceGroupUUID name: InterfaceGroup1 type: InterfaceGroup monitorAddress: 1.1.1.1 name: SLA1 noOfPackets: 1 slaId: 1 threshold: 2 timeout: 5000 tos: 1 type: SLAMonitor ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/slamonitors?bulk=true ( bulk POST example for SLA monitor object )' : value: - dataSize: 28 description: Sla monitor description frequency: 60 interfaceObjects: - id: securityZoneUUID name: SecZone1 type: SecurityZone - id: interfaceGroupUUID name: InterfaceGroup1 type: InterfaceGroup monitorAddress: 1.1.1.1 name: SLA1 noOfPackets: 1 slaId: 1 threshold: 2 timeout: 5000 tos: 1 type: SLAMonitor - dataSize: 28 description: Sla monitor description frequency: 60 interfaceObjects: - id: securityZoneUUID name: SecZone1 type: SecurityZone - id: interfaceGroupUUID name: InterfaceGroup1 type: InterfaceGroup monitorAddress: 1.1.1.1 name: SLA2 noOfPackets: 1 slaId: 1 threshold: 2 timeout: 5000 tos: 1 type: SLAMonitor schema: $ref: '#/components/schemas/SLAMonitorObjectModel' type: object description: Input representation of sla monitor object. required: true responses: '201': content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/slamonitors ( POST method for SLA Monitor Object )': value: dataSize: 28 description: Sla monitor description frequency: 60 id: slaMonitorObjectUUID interfaceObjects: - id: securityZoneUUID name: SecZone1 type: SecurityZone - id: interfaceGroupUUID name: InterfaceGroup1 type: InterfaceGroup links: parent: /api/fmc_config/v1/domain/DomainUUID/object/slamonitors self: /api/fmc_config/v1/domain/DomainUUID/object/slamonitors/slaMonitorObjectUUID monitorAddress: 1.1.1.1 name: SLA1 noOfPackets: 1 slaId: 1 threshold: 2 timeout: 5000 tos: 1 type: SLAMonitor ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/slamonitors?bulk=true ( bulk POST example for SLA monitor object )' : value: items: - dataSize: 28 description: ' ' frequency: 60 id: SLA1_UUID interfaceObjects: - id: securityZoneUUID name: SecZone1 type: SecurityZone - id: interfaceGroupUUID name: InterfaceGroup1 type: InterfaceGroup links: self: /api/fmc_config/v1/domain/DomainUUID/object/slamonitors/SLA1_UUID metadata: domain: id: DomainUUID name: Global lastUser: name: pvs timestamp: 0 monitorAddress: 1.2.3.4 name: SLA1 noOfPackets: 1 slaId: 12 threshold: 5000 timeout: 5000 tos: 0 type: SLAMonitor - dataSize: 28 description: ' ' frequency: 60 id: SLA2_UUID interfaceObjects: - id: securityZoneUUID name: SecZone1 type: SecurityZone - id: interfaceGroupUUID name: InterfaceGroup1 type: InterfaceGroup links: self: /api/fmc_config/v1/domain/DomainUUID/object/slamonitors/SLA2_UUID metadata: domain: id: DomainUUID name: Global lastUser: name: pvs timestamp: 0 monitorAddress: 1.2.3.4 name: SLA2 noOfPackets: 1 slaId: 12 threshold: 5000 timeout: 5000 tos: 0 type: SLAMonitor links: self: /api/fmc_config/v1/domain/DomainUUID/object/slamonitors?bulk=true schema: $ref: '#/components/schemas/SLAMonitorObjectModel' 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/slamonitors/{objectId}: delete: deprecated: false description: '**Delete the service level agreement monitor associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteSLAMonitorObjectModel parameters: - description: Unique identifier of the service level agreement monitor. 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/slamonitors/slaMonitorObjectUUID ( DELETE method for SLA Monitor Object )' : value: dataSize: 28 description: Sla monitor description frequency: 60 id: slaMonitorObjectUUID interfaceNames: - Interface1 interfaceObjects: - id: securityZoneUUID name: SecZone1 type: SecurityZone - id: interfaceGroupUUID name: InterfaceGroup1 type: InterfaceGroup links: parent: /api/fmc_config/v1/domain/DomainUUID/object/slamonitors self: /api/fmc_config/v1/domain/DomainUUID/object/slamonitors/slaMonitorObjectUUID monitorAddress: 1.1.1.1 name: SLA1 noOfPackets: 1 slaId: 1 threshold: 2 timeout: 5000 tos: 1 type: SLAMonitor schema: $ref: '#/components/schemas/SLAMonitorObjectModel' 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 service level agreement monitor associated with the specified ID.**' operationId: getSLAMonitorObjectModel parameters: - description: Unique identifier of the service level agreement monitor. 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/slamonitors/slaMonitorObjectUUID ( Get sla monitors object by id )': value: dataSize: 28 description: Sla monitor description frequency: 60 id: slaMonitorObjectUUID interfaceNames: - Interface1 interfaceObjects: - id: securityZoneUUID name: SecZone1 type: SecurityZone - id: interfaceGroupUUID name: InterfaceGroup1 type: InterfaceGroup links: self: /fmc_config/v1/domain/DomainUUID/object/slamonitors/slaMonitorObjectUUID monitorAddress: 1.1.1.1 name: SLA1 noOfPackets: 1 slaId: 1 threshold: 2 timeout: 5000 tos: 1 type: SLAMonitor schema: $ref: '#/components/schemas/SLAMonitorObjectModel' 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 service level agreement monitor associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateSLAMonitorObjectModel parameters: - description: Unique identifier of the service level agreement monitor. 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/slamonitors/slaMonitorObjectUUID ( PUT method for SLA Monitor Object )' : value: dataSize: 28 description: Sla monitor description updated frequency: 60 id: slaMonitorObjectUUID interfaceNames: - Interface1 - 'comment : For interfaceNames the only option in PUT is to remove these, no new additions of inline interface names will be allowed.' interfaceObjects: - id: securityZoneUUID name: SecZone1 type: SecurityZone - id: interfaceGroupUUID name: InterfaceGroup1 type: InterfaceGroup monitorAddress: 1.1.1.2 name: SLA1-Updated noOfPackets: 1 slaId: 1 threshold: 2 timeout: 5000 tos: 1 type: SLAMonitor schema: $ref: '#/components/schemas/SLAMonitorObjectModel' type: object description: Input representation of sla monitor object. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/slamonitors/slaMonitorObjectUUID ( PUT method for SLA Monitor Object )' : value: dataSize: 28 description: Sla monitor description updated frequency: 60 id: slaMonitorObjectUUID interfaceNames: - Interface1 interfaceObjects: - id: securityZoneUUID name: SecZone1 type: SecurityZone - id: interfaceGroupUUID name: InterfaceGroup1 type: InterfaceGroup links: parent: /api/fmc_config/v1/domain/DomainUUID/object/slamonitors self: /api/fmc_config/v1/domain/DomainUUID/object/slamonitors/slaMonitorObjectUUID monitorAddress: 1.1.1.2 name: SLA1-Updated noOfPackets: 1 slaId: 1 threshold: 2 timeout: 5000 tos: 1 type: SLAMonitor schema: $ref: '#/components/schemas/SLAMonitorObjectModel' 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/ssoservers: get: deprecated: false description: '**Get the list of all SSO server policies.**' operationId: getAllSSOServer 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/ssoserver?limit=2&expanded=false ( Get all paginated SSOServer objects with limit set 2 )' : value: items: - id: SSOServer-1UUID links: self: /api/fmc_config/v1/domain/DomainUUID/object/ssoservers/ssoserverUUID name: SSOServer-1 type: SSOServer - id: SSOServer-2UUID links: self: /api/fmc_config/v1/domain/DomainUUID/object/ssoservers/ssoserverUUID name: SSOServer-2 type: SSOServer links: self: /fmc_config/v1/domain/DomainUUID/object/ssoserver?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/ssoserver?limit=2&expanded=true ( Get all paginated SSO objects with limit set 2 and expanded is set to true )' : value: items: - baseUrl: https://172.33.34.222 description: SSO object description id: SSOServer-2UUID identityProviderCert: id: cert55UUID name: cert55 type: CertEnrollment idpEntityId: salesforce_idp links: self: /api/fmc_config/v1/domain/DomainUUID/object/ssoservers/ssoserverUUID logoutURL: https://asa-dev-ed.my.salesforce.com/idp/endpoint/HttpRedirect metadata: domain: id: DomainUUID name: Global type: Domain lastUser: name: admin timestamp: 1999591947310.0 name: SSOServer-2 overridable: true requestTimeout: 7200 serverOnInternalNetwork: true serviceProviderCert: id: trustedcacert2UUID name: trustedcacert2 type: CertEnrollment signatureType: RSA_SHA512 ssoURL: https://asa-dev-ed.my.salesforce.com/idp/endpoint/HttpRedirect type: SSOServer - baseUrl: https://172.22.33.202 description: SSO object description id: SSOServer-2UUID identityProviderCert: id: cert-1UUID name: cert-1 type: CertEnrollment idpEntityId: salesforce_idp links: self: /api/fmc_config/v1/domain/DomainUUID/object/ssoservers/ssoserverUUID logoutURL: https://asa-dev-ed.my.salesforce.com/idp/endpoint/HttpRedirect metadata: domain: id: DomainUUID name: Global type: Domain lastUser: name: admin timestamp: 1679591947310.0 name: SSOServer-2 overridable: true requestTimeout: 7200 serverOnInternalNetwork: true serviceProviderCert: id: trustedcacertUUID name: trustedcacert type: CertEnrollment signatureType: RSA_SHA384 ssoURL: https://asa-dev-ed.my.salesforce.com/idp/endpoint/HttpRedirect type: SSOServer links: self: /fmc_config/v1/domain/DomainUUID/object/ssoserver?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/SSOServerListContainer' 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 SSO server policy. _Check the response section for applicable examples (if any)._**' operationId: createMultipleSSOServer 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: schema: $ref: '#/components/schemas/SSOServer' type: object description: The input SSO Server Policy Object model. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/SSOServer' 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/ssoservers/{containerUUID}/overrides: get: deprecated: false description: '**Get all overrides on the specified SSO server policy. Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored.**' operationId: getSSOServerOverride 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/ssoservers/ssoserverUUID/overrides ( Get all overrides for sso server object )' : value: items: - baseUrl: https://172.23.34.222 description: ' ' id: SSO_1UUID identityProviderCert: id: cert26UUID name: cert26 type: CertEnrollment idpEntityId: salesforce_idp links: self: /fmc_config/v1/domain/domainUUID/object/ssoservers/ssoserverUUID?overrideTargetId=targetUUID logoutURL: https://asa-dev-ed.my.salesforce.com/idp/endpoint/HttpRedirect metadata: domain: id: domainUUID name: Global \ INDIA lastUser: name: user1 timestamp: number name: SSO_1 overridable: true overrides: parent: id: ssoserverUUID type: ssoservers target: id: targetUUID name: 10.10.19.25 type: Device requestTimeout: 7200 serverOnInternalNetwork: true serviceProviderCert: id: trustedca1UUID name: trustedca1 type: CertEnrollment signatureType: RSA_SHA256 ssoURL: https://asa-dev-ed.my.salesforce.com/idp/endpoint/HttpRedirect type: ssoservers links: self: /fmc_config/v1/domain/domainUUID/object/ssoservers/ssoserverUUID/overrides?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/SSOServerOverrideListContainer' 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/ssoservers/{objectId}: delete: deprecated: false description: '**Delete the SSO server policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteSSOServer parameters: - description: Unique identifier of the SSO server 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: schema: $ref: '#/components/schemas/SSOServer' 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 SSO server policy associated with the specified ID.**' operationId: getSSOServer parameters: - description: Unique identifier of the SSO server policy. in: path name: objectId required: true schema: type: string - description: Get the overrides associated with the specified SSO server policy. 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/ssoservers/ssoserverUUID ( SSO Server object description )': value: baseUrl: https://172.23.34.222 description: SSO object description id: SSOServer-1UUID identityProviderCert: id: cert56UUID name: cert56 type: CertEnrollment idpEntityId: salesforce_idp links: self: /api/fmc_config/v1/domain/DomainUUID/object/ssoservers/ssoserverUUID logoutURL: https://asa-dev-ed.my.salesforce.com/idp/endpoint/HttpRedirect name: SSOServer-1 overridable: true requestTimeout: 7200 serverOnInternalNetwork: true serviceProviderCert: id: trustedcacert1UUID name: trustedcacert1 type: CertEnrollment signatureType: RSA_SHA256 ssoURL: https://asa-dev-ed.my.salesforce.com/idp/endpoint/HttpRedirect type: SSOServer schema: $ref: '#/components/schemas/SSOServer' 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 SSO server policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateSSOServer parameters: - description: Unique identifier of the SSO server 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: schema: $ref: '#/components/schemas/SSOServer' type: object description: The input SSO Server Policy Object model. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SSOServer' 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/standardaccesslists: get: deprecated: false description: '**Get the list of all standard access lists.**' operationId: getAllStandardACL 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/standardaccesslists ( Test GET All of StandardAccessList Object )' : value: items: - description: ' ' entries: - action: PERMIT networks: literals: - type: Host value: 1.1.1.1 objects: - id: 00000000-0000-0ed3-0000-270582939747 overridable: false type: NetworkGroup id: stdACLObjectUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/standardaccesslists/stdACLObjectUUID name: StandardAccessListTest overridable: false type: StandardAccessList - description: ' ' entries: - action: PERMIT networks: objects: - id: 00000000-0000-0ed3-0000-270582939747 overridable: false type: NetworkGroup id: stdACLObjectUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/standardaccesslists/stdACLObjectUUID name: StandardAccessListTestNew overridable: false type: StandardAccessList links: self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/standardaccesslists?offset=0&limit=2&expanded=true paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/StandardACLListContainer' 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 standard access list. _Check the response section for applicable examples (if any)._**' operationId: createStandardACL 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/standardaccesslists ( Test POST of StandardAccessList Object )' : value: entries: - action: PERMIT networks: literals: - type: Host value: 1.1.1.1 objects: - id: 00000000-0000-0ed3-0000-270582939747 name: StandardAccessListTest schema: $ref: '#/components/schemas/StandardACL' type: object description: Input representation of Standard Access List object. required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /api/fmc_config/v1/domain/{domainUUID}/object/standardaccesslists ( Test POST of StandardAccessList Object )' : value: description: ' ' entries: - action: PERMIT networks: literals: - type: Host value: 1.1.1.1 objects: - id: 00000000-0000-0ed3-0000-270582939747 overridable: false type: NetworkGroup id: stdACLObjectUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/standardaccesslists/stdACLObjectUUID metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 0 name: StandardAccessListTest overridable: false type: StandardAccessList schema: $ref: '#/components/schemas/StandardACL' 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/standardaccesslists/{objectId}: delete: deprecated: false description: '**Delete the standard access list associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteStandardACL parameters: - description: Unique identifier of the standard 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/standardaccesslists/{objectId} ( Test DELETE of StandardAccessList Object )' : value: description: ' ' entries: - action: DENY networks: objects: - id: 00000000-0000-0ed3-0000-270582939747 overridable: false type: NetworkGroup id: stdACLObjectUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/standardaccesslists/stdACLObjectUUID metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 0 name: StandardAccessListTest overridable: false type: StandardAccessList schema: $ref: '#/components/schemas/StandardACL' 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 standard access list associated with the specified ID.**' operationId: getStandardACL parameters: - description: Unique identifier of the standard 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/standardaccesslists/{objectId} ( Test GET of StandardAccessList Object )' : value: description: ' ' entries: - action: PERMIT networks: literals: - type: Host value: 1.1.1.1 objects: - id: 00000000-0000-0ed3-0000-270582939747 overridable: false type: NetworkGroup id: stdACLObjectUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/standardaccesslists/stdACLObjectUUID metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 0 name: StandardAccessListTest overridable: false type: StandardAccessList schema: $ref: '#/components/schemas/StandardACL' 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 standard access list associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateStandardACL parameters: - description: Unique identifier of the standard 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/standardaccesslists/{objectId} ( Test PUT of StandardAccessList Object )' : value: entries: - action: DENY networks: objects: - id: 00000000-0000-0ed3-0000-270582939747 id: stdACLObjectUUID name: StandardAccessListTest schema: $ref: '#/components/schemas/StandardACL' type: object description: Input representation of Standard Access List object. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/{domainUUID}/object/standardaccesslists/{objectId} ( Test PUT of StandardAccessList Object )' : value: description: ' ' entries: - action: DENY networks: objects: - id: 00000000-0000-0ed3-0000-270582939747 overridable: false type: NetworkGroup id: stdACLObjectUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/{domainUUID}/object/standardaccesslists/stdACLObjectUUID metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 0 name: StandardAccessListTest overridable: false type: StandardAccessList schema: $ref: '#/components/schemas/StandardACL' 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/standardcommunitylists: get: deprecated: false description: '**Get the list of all standard community lists.**' operationId: getAllStandardCommunityList 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/standardcommunitylists ( Success: Test GET ALL success )': value: items: - entries: - action: PERMIT communities: '8098' internet: true noAdvertise: true noExport: true seqnumber: 1 type: Standard - action: DENY communities: '987' internet: false noAdvertise: false noExport: false seqnumber: 2 type: Standard id: 00505681-3A7E-0ed3-0000-021474836483 links: self: https://FMC-HOST/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/standardcommunitylists/00505681-3A7E-0ed3-0000-021474836483 name: S1 overridable: false type: CommunityListObject - entries: - action: PERMIT communities: '345' internet: true noAdvertise: false noExport: true seqnumber: 1 type: Standard - action: DENY communities: '567' internet: false noAdvertise: true noExport: false seqnumber: 2 type: Standard id: 00505681-3A7E-0ed3-0000-017179869216 links: self: https://FMC-HOST/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/standardcommunitylists/00505681-3A7E-0ed3-0000-017179869216 name: Standard overridable: false type: CommunityListObject links: self: https://FMC-HOST/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/standardcommunitylists?offset=0&limit=2&expanded=true paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/StandardCommunityListListContainer' 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 standard community list. _Check the response section for applicable examples (if any)._**' operationId: createStandardCommunityList 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/StandardCommunityList' type: object description: Payload representing standard community list object. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/StandardCommunityList' 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/standardcommunitylists/{objectId}: delete: deprecated: false description: '**Delete the standard community list associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteStandardCommunityList parameters: - description: Unique identifier of the standard 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/StandardCommunityList' 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 standard community list associated with the specified ID.**' operationId: getStandardCommunityList parameters: - description: Unique identifier of the standard 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/StandardCommunityList' 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 standard community list associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateStandardCommunityList parameters: - description: Unique identifier of the standard 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/StandardCommunityList' type: object description: Payload representing standard community list object. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/StandardCommunityList' 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/testazureadrealms: post: deprecated: false description: '**Test Azure AD realm connectivity. _Check the response section for applicable examples (if any)._**' operationId: createTestAzureADRealm parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/TestAzureADRealm' type: object description: Input representation of an Azure AD Realm required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/TestAzureADRealm' 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/timeranges: get: deprecated: false description: '**Get the list of all time ranges.**' operationId: getAllTimeRange 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/timeranges?limit=2 ( Get all paginated TimeRange objects with limit=5 )' : value: items: - description: sample description id: 0050568A-906F-0ed3-0000-343597383765 links: self: /fmc_config/v1/domain/DomainUUID/policy/prefilterpolicies/containerUUID/object/timeranges/0050568A-906F-0ed3-0000-343597383765 name: TimeRange_test1 overridable: false type: TimeRange - description: sample description effectiveEndDateTime: 2018-09-19 13:00:00 effectiveStartDateTime: 2018-08-16 08:00:00 id: 0050568A-906F-0ed3-0000-446676598787 links: self: /fmc_config/v1/domain/DomainUUID/policy/prefilterpolicies/containerUUID/object/timeranges/0050568A-906F-0ed3-0000-446676598787 name: TimeRange_test2 overridable: false recurrenceList: - dailyEndTime: 09:00 dailyStartTime: 08:00 days: - MON - TUE recurrenceType: DAILY_INTERVAL type: TimeRange - description: sample description effectiveEndDateTime: 2018-09-19 13:00:00 effectiveStartDateTime: 2018-08-16 08:00:00 id: 0050568A-906F-0ed3-0000-343597383683 links: self: /fmc_config/v1/domain/DomainUUID/policy/prefilterpolicies/containerUUID/object/timeranges/0050568A-906F-0ed3-0000-343597383683 name: TimeRange_test3 overridable: false recurrenceList: - dailyEndTime: '16:00' dailyStartTime: '10:00' days: - WED - SAT recurrenceType: DAILY_INTERVAL - rangeEndDay: FRI rangeStartDay: MON recurrenceType: RANGE type: TimeRange - description: sample description id: 0050568A-906F-0ed3-0000-575525617667 links: self: /fmc_config/v1/domain/DomainUUID/policy/prefilterpolicies/containerUUID/object/timeranges/0050568A-906F-0ed3-0000-575525617667 name: TimeRange_test4 overridable: false type: TimeRange links: self: /fmc_config/v1/domain/DomainUUID/object/timeranges?offset=0&limit=2 paging: count: 10 limit: 5 next: - /fmc_config/v1/domain/DomainUUID/object/timeranges?offset=5&limit=5 offset: 0 pages: 2 schema: $ref: '#/components/schemas/TimeRangeListContainer' 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 time range. _Check the response section for applicable examples (if any)._**' operationId: createMultipleTimeRange 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/timeranges ( Test POST of TimeRange object to create a new record )' : value: description: ' ' effectiveEndDateTime: 2019-09-21 17:53:00 effectiveStartDateTime: 2019-09-19 15:53:00 name: TestTimeRange recurrenceList: - dailyEndTime: 09:00 dailyStartTime: 08:00 days: - MON - TUE - FRI recurrenceType: DAILY_INTERVAL - rangeEndDay: FRI rangeEndTime: '11:00' rangeStartDay: MON rangeStartTime: 09:00 recurrenceType: RANGE type: TimeRange schema: $ref: '#/components/schemas/TimeRange' type: object description: The input TimeRange object model. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/TimeRange' 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/timeranges/{objectId}: delete: deprecated: false description: '**Delete the time range associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteTimeRange parameters: - description: Unique identifier of the time range. 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/timeranges ( Test DELETE of TimeRange object )': value: description: Test REST API Object updated name: test1 overridable: false type: TimeRange value: 102.102.102.0/24 schema: $ref: '#/components/schemas/TimeRange' 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 time range associated with the specified ID.**' operationId: getTimeRange parameters: - description: Unique identifier of the time range. 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/TimeRange' 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 time range associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateTimeRange parameters: - description: Unique identifier of the time range. 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/timeranges ( Test PUT of new TimeRange object )': value: description: sample description effectiveEndDateTime: 16/08/2018T08:00 id: 0050568A-906F-0ed3-0000-343597383765 name: test_updated overridable: false type: TimeRange schema: $ref: '#/components/schemas/TimeRange' type: object description: The input TimeRange object model. required: true responses: '200': content: application/json: examples: 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/timeranges ( Test PUT of new TimeRange object )': value: description: sample description id: 0050568A-906F-0ed3-0000-343597383765 name: test_updated overridable: false type: TimeRange schema: $ref: '#/components/schemas/TimeRange' 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/timezoneobjects: get: deprecated: false description: '**Get the list of all time zone objects.**' operationId: getAllTimeZoneObject 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/timezoneobjects ( Get all paginated TimeZoneObject resources with limit=2 )' : value: items: - description: ' ' id: timeZoneObjectId1 links: self: /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/timeZoneObjectId1 metadata: domain: id: DomainUUID name: Domain Name type: Domain lastUser: name: api timestamp: 0 name: TestObj1 overridable: false timeZone: (UTC+05:30) Asia/Calcutta timeZoneId: Asia/Calcutta type: TimeZoneObject - description: ' ' dstDayRecurrence: endDayOfWeek: TUE endMonth: FEB endTime: '11:01' endWeek: SECOND offset: 20 startDayOfWeek: MON startMonth: JAN startTime: '11:00' startWeek: FIRST id: timeZoneObjectId2 links: self: /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/timeZoneObjectId2 metadata: domain: id: DomainUUID name: Domain Name type: Domain lastUser: name: api timestamp: 0 name: TestObj2 overridable: false timeZone: (UTC+05:30) Asia/Calcutta timeZoneId: Asia/Calcutta type: TimeZoneObject links: self: /fmc_config/v1/domain/DomainUUID/object/timezoneobjects?offset=0&limit=2 paging: count: 0 limit: 2 next: - /fmc_config/v1/domain/DomainUUID/object/timezoneobjects?offset=0&limit=2 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/timezoneobjects?overrideTargetId=target_uuid ( Get all paginated TimeZoneObject objects without offset and limit )' : value: items: - id: objectId links: self: /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/objectId?overrideTargetId=target_uuid name: tz01 type: TimeZoneObject links: self: /fmc_config/v1/domain/DomainUUID/object/timezoneobjects?overrideTargetId=target_uuid paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/TimeZoneObjectListContainer' 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 time zone object. _Check the response section for applicable examples (if any)._**' operationId: createMultipleTimeZoneObject 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/timezoneobjects ( Test POST of TimeZoneObject resource to create a new record )' : value: dstDayRecurrence: endDayOfWeek: TUE endMonth: FEB endTime: '11:01' endWeek: SECOND offset: 20 startDayOfWeek: MON startMonth: JAN startTime: '11:00' startWeek: FIRST name: TestPOSTObject timeZoneId: Asia/Calcutta type: TimeZoneObject ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/timezoneobjects ( POST request to create an override on TimeZoneObject )' : value: description: ' ' id: objectId name: tz01 overridable: true overrides: parent: id: objectId type: TimeZoneObject target: id: targetId name: Global \ test_domain type: Domain timeZoneId: US/Samoa type: TimeZoneObject schema: $ref: '#/components/schemas/TimeZoneObject' type: object description: The input Time Zone object model. required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/timezoneobjects ( Test POST of TimeZoneObject resource to create a new record )' : value: description: ' ' dstDayRecurrence: endDayOfWeek: TUE endMonth: FEB endTime: '11:01' endWeek: SECOND offset: 20 startDayOfWeek: MON startMonth: JAN startTime: '11:00' startWeek: FIRST id: timeZoneObjectId links: self: /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/timeZoneObjectId metadata: domain: id: DomainUUID name: Domain Name type: Domain lastUser: name: api timestamp: 0 name: TestPOSTObject overridable: false timeZone: (UTC+05:30) Asia/Calcutta timeZoneId: Asia/Calcutta type: TimeZoneObject ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/timezoneobjects ( POST request to create an override on TimeZoneObject )' : value: description: ' ' id: objectId links: self: /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/objectId?overrideTargetId=targetId metadata: domain: id: targetId name: Global \ test_domain type: Domain lastUser: name: api timestamp: 0 name: tz01 overridable: true overrides: parent: id: objectId type: TimeZoneObject target: id: targetId name: Global \ test_domain type: Domain timeZone: (UTC-11:00) US/Samoa timeZoneId: US/Samoa type: TimeZoneObject schema: $ref: '#/components/schemas/TimeZoneObject' 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/timezoneobjects/{containerUUID}/overrides: get: deprecated: false description: '**Get all overrides on the specified time zone object. Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored.**' operationId: getTimeZoneObjectOverride 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/timezoneobjects/overrides ( Get all overrides on TimeZoneObjects )': value: items: - description: ' ' id: objectId links: self: /fmc_config/v1/domain/globalDomainId/object/timezoneobjects/objectId?overrideTargetId=targetId metadata: domain: id: domainId name: TargetDomain type: Domain lastUser: name: api timestamp: 1234567890.0 name: TestObject overridable: true overrides: parent: id: objectId type: TimeZoneObject target: id: targetId name: targetName type: targetType timeZone: (UTC-11:00) US/Samoa timeZoneId: US/Samoa type: TimeZoneObject links: self: /fmc_config/v1/domain/globalDomainId/object/timezoneobjects/objectId/overrides?offset=0&limit=1 paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/TimeZoneObjectOverrideListContainer' 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/timezoneobjects/{objectId}: delete: deprecated: false description: '**Delete the time zone object associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteTimeZoneObject parameters: - description: Unique identifier of the time zone object. in: path name: objectId required: true schema: type: string - description: Get the overrides associated with the specified time zone 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 : DELETE /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/timeZoneObjectId ( Test DELETE of TimeZoneObject resource )' : value: description: ' ' id: timeZoneObjectId links: self: /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/timeZoneObjectId metadata: domain: id: DomainUUID name: Domain Name type: Domain lastUser: name: api timestamp: 0 name: ExampleDELETEobject overridable: false timeZone: (UTC+05:30) Asia/Calcutta timeZoneId: Asia/Calcutta type: TimeZoneObject ? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/objectId?overrideTargetId=targetId ( DELETE request to remove an override on TimeZoneObject )' : value: description: ' ' id: objectId links: self: /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/objectId?overrideTargetId=targetId metadata: domain: id: targetId name: Global \ test_domain type: Domain lastUser: name: api timestamp: 0 name: tz01 overridable: true overrides: parent: id: objectId type: TimeZoneObject target: id: targetId name: Global \ test_domain type: Domain timeZone: (UTC-11:00) US/Samoa timeZoneId: US/Samoa type: TimeZoneObject schema: $ref: '#/components/schemas/TimeZoneObject' 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 time zone object associated with the specified ID.**' operationId: getTimeZoneObject parameters: - description: Unique identifier of the time zone object. in: path name: objectId required: true schema: type: string - description: Get the overrides associated with the specified time zone 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/timezoneobjects/timeZoneObjectId1 ( Get TimeZoneObject resource with specified identifier. )' : value: description: ' ' id: timeZoneObjectId1 links: self: /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/timeZoneObjectId1 metadata: domain: id: DomainUUID name: Domain Name type: Domain lastUser: name: api timestamp: 0 name: TestObj1 overridable: false timeZone: (UTC+05:30) Asia/Calcutta timeZoneId: Asia/Calcutta type: TimeZoneObject schema: $ref: '#/components/schemas/TimeZoneObject' 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 time zone object associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateTimeZoneObject parameters: - description: Unique identifier of the time zone 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/timezoneobjects/timeZoneObjectId ( Test PUT of new TimeZoneObject resource )' : value: description: edited id: timeZoneObjectId name: TestPUTObject timeZoneId: Asia/Calcutta type: TimeZoneObject ? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/objectId ( PUT request to update an override on TimeZoneObject )' : value: description: ' ' id: objectId name: tz01 overridable: true overrides: parent: id: objectId type: TimeZoneObject target: id: targetId name: Global \ test_domain type: Domain timeZoneId: US/Samoa type: TimeZoneObject schema: $ref: '#/components/schemas/TimeZoneObject' type: object description: The input Time Zone object model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/timeZoneObjectId ( Test PUT of new TimeZoneObject resource )' : value: description: ' ' dstDayRecurrence: endDayOfWeek: TUE endMonth: FEB endTime: '11:01' endWeek: SECOND offset: 20 startDayOfWeek: MON startMonth: JAN startTime: '11:00' startWeek: FIRST id: timeZoneObjectId links: self: /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/timeZoneObjectId metadata: domain: id: DomainUUID name: Domain Name type: Domain lastUser: name: api timestamp: 0 name: TestPUTObject overridable: false timeZone: (UTC+05:30) Asia/Calcutta timeZoneId: Asia/Calcutta type: TimeZoneObject ? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/objectId ( PUT request to update an override on TimeZoneObject )' : value: description: ' ' id: objectId links: self: /fmc_config/v1/domain/DomainUUID/object/timezoneobjects/objectId?overrideTargetId=targetId metadata: domain: id: targetId name: Global \ test_domain type: Domain lastUser: name: api timestamp: 0 name: tz01 overridable: true overrides: parent: id: objectId type: TimeZoneObject target: id: targetId name: Global \ test_domain type: Domain timeZone: (UTC-11:00) US/Samoa timeZoneId: US/Samoa type: TimeZoneObject schema: $ref: '#/components/schemas/TimeZoneObject' 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/tunneltags: get: deprecated: false description: '**Get the list of all tunnel tags.**' operationId: getAllTunnelTags 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/tunneltags ( Success: Test GET ALL success )': value: items: - id: tunnelTagObj1UUID links: self: /fmc_config/v1/domain/domainUUID/object/tunneltags/tunnelTagObj1UUID name: TT_obj1 type: TunnelTag - id: tunnelTagObj2UUID links: self: /fmc_config/v1/domain/domainUUID/object/tunneltags/tunnelTagObj2UUID name: TT_obj2 type: TunnelTag - id: tunnelTagObj3UUID links: self: /fmc_config/v1/domain/domainUUID/object/tunneltags/tunnelTagObj3UUID name: TT_obj3 type: TunnelTag paging: count: 3 limit: 3 offset: 0 pages: 1 schema: $ref: '#/components/schemas/TunnelTagsListContainer' 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 tunnel tag. _Check the response section for applicable examples (if any)._**' operationId: createMultipleTunnelTags 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/tunneltags/{objectId} ( Success: Test POST method for TunnelTag )' : value: description: Tunnel Tag description name: NewTunnelTag type: TunnelTag ? 'Example 2 : POST /fmc_config/v1/domain/{domainUUID}/object/tunneltags?bulk=true ( Bulk POST operation on Tunnel tag objects )' : value: - description: Tunnel Tag description name: NewTunnelTag1 type: TunnelTag - description: Tunnel Tag description name: NewTunnelTag2 type: TunnelTag schema: $ref: '#/components/schemas/TunnelTags' type: object description: The input tunnel tags model. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/TunnelTags' 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/tunneltags/{objectId}: delete: deprecated: false description: '**Delete the tunnel tag associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteTunnelTags parameters: - description: Unique identifier of the tunnel tag. 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: '204': content: application/json: examples: 'Example 1 : DELETE /fmc_config/v1/domain/{domainUUID}/object/tunneltags/{objectId} ( Test DELETE of TunnelTag Object )': value: description: Tunnel Tag description id: TunnelTagObjectUUID links: self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/tunneltags/{objectId} metadata: domain: id: Object id name: Global lastUser: name: admin timestamp: 1544094109706.0 name: NewTunnel type: TunnelTag schema: $ref: '#/components/schemas/TunnelTags' type: object description: No Content default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Object get: deprecated: false description: '**Get the tunnel tag associated with the specified ID.**' operationId: getTunnelTags parameters: - description: Unique identifier of the tunnel tag. 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/tunneltags/tunnelTagObj1UUID ( Test GET of tunnel tag object for a uuid )' : value: description: some description id: tunnelTagObj1UUID name: TT_obj1 type: TunnelTag schema: $ref: '#/components/schemas/TunnelTags' 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 tunnel tag associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateTunnelTags parameters: - description: Unique identifier of the tunnel tag. 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/TunnelTags' type: object description: The input tunnel tags model. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TunnelTags' 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/urlcategories: get: deprecated: false description: '**Get the list of all URL categories.**' operationId: getAllURLCategory 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/urlcategories?limit=2 ( Get all paginated URLCategory with limit set 2 )' : value: items: - id: urlCategoryUUID links: self: /fmc_config/v1/domain/DomainUUID/object/urlcategories/urlCategoryUUID name: Auctions type: URLCategory - id: urlCategoryUUID links: self: /fmc_config/v1/domain/DomainUUID/object/urlcategories/urlCategoryUUID name: Bot Nets type: URLCategory links: self: /fmc_config/v1/domain/DomainUUID/object/urlcategories?offset=0&limit=2 paging: count: 5 limit: 2 next: - /fmc_config/v1/domain/DomainUUID/object/urlcategories?offset=2&limit=2 - /fmc_config/v1/domain/DomainUUID/object/urlcategories?offset=4&limit=29 offset: 0 pages: 3 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/urlcategories?limit=2&expanded=true ( Get all paginated URL category with limit set 2 )' : value: items: - id: urlCategoryUUID links: self: /fmc_config/v1/domain/DomainUUID/object/urlcategories/urlCategoryUUID name: Auctions type: URLCategory - id: urlCategoryUUID links: self: /fmc_config/v1/domain/DomainUUID/object/urlcategories/urlCategoryUUID name: Bot Nets type: URLCategory links: self: /fmc_config/v1/domain/DomainUUID/object/urlcategories?offset=0&limit=2 paging: count: 84 limit: 2 next: - /fmc_config/v1/domain/DomainUUID/object/urlcategories?offset=2&limit=2 - /fmc_config/v1/domain/DomainUUID/object/urlcategories?offset=4&limit=2 - /fmc_config/v1/domain/DomainUUID/object/urlcategories?offset=6&limit=2 - /fmc_config/v1/domain/DomainUUID/object/urlcategories?offset=8&limit=2 offset: 0 pages: 4 schema: $ref: '#/components/schemas/URLCategoryListContainer' 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/urlcategories/{objectId}: get: deprecated: false description: '**Get the URL category associated with the specified ID.**' operationId: getURLCategory parameters: - description: Unique identifier of the URL category. 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/urlcategories/urlCategoryUUID ( Get url category by id )': value: id: urlCategoryUUID links: self: /fmc_config/v1/domain/DomainUUID/object/urlcategories/urlCategoryUUID name: Auctions type: URLCategory schema: $ref: '#/components/schemas/URLCategory' 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/urlgroups: delete: deprecated: false description: '**Delete all URL groups. Use filtering to specfiy which URL groups will be deleted. _Check the response section for applicable examples (if any)._**' operationId: deleteMultipleURLGroupObject 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/urlgroups/UrlGroupUUID2 ( Test DELETE of UrlGroup Object )': value: id: UrlGroupUUID2 literals: - type: Url url: www.google.com name: urlgroup_obj2 objects: - id: UrlObjectUUID type: Url type: UrlGroup ? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/urlgroups/urlgrp1_uuid?overrideTargetId=target_uuid ( DELETE request to remove an override on url group )' : value: description: ' ' id: urlgrp1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urlgroups/urlgrp1_uuid?overrideTargetId=target_uuid literals: - type: Url url: www.google.com metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 1527360182370.0 name: urlgrp1 objects: - id: url1_uuid name: url1 overridable: false type: Url overridable: true overrides: parent: id: urlgrp1_uuid type: UrlGroup target: id: target_uuid name: 10.10.16.29 type: Device type: UrlGroup schema: $ref: '#/components/schemas/URLGroupObject' 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 URL groups.**' operationId: getAllURLGroupObject 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/DomainUUID/object/urlgroups?expanded=true ( Get all paginated urlgroup objects without offset and limit )' : value: items: - description: ' ' id: urlgrp1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urlgroups/urlgrp1_uuid literals: - type: Url url: www.google.com metadata: domain: id: domainUuid name: Global lastUser: name: pvs timestamp: 1528178387150.0 name: urlgrp1 objects: - id: url1_uuid name: url1 overridable: false type: Url overridable: true type: UrlGroup links: self: /api/fmc_config/v1/domain/domainUuid/object/urlgroups?offset=0&limit=1&expanded=true paging: count: 1 limit: 1 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/urlgroups?overrideTargetId=target_uuid&expanded=true ( Get all paginated urlgroup objects without offset and limit )' : value: items: - description: ' ' id: urlgrp1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urlgroups/urlgrp1_uuid?overrideTargetId=device_uuid literals: - type: Url url: www.google.com metadata: domain: id: domain_Uuid name: Global \ ASIA \ INDIA lastUser: name: pvs timestamp: 1528178384030.0 name: urlgrp1 objects: - id: url1_uuid name: url1 overridable: false type: Url overridable: true overrides: parent: id: urlgrp1_uuid type: UrlGroup target: id: device_uuid name: 10.10.16.29 type: Device type: UrlGroup links: self: /api/fmc_config/v1/domain/domainUuid/object/urlgroups?offset=0&limit=1&overrideTargetId=device_uuid&expanded=true paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/URLGroupObjectListContainer' 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 URL group. _Check the response section for applicable examples (if any)._**' operationId: createMultipleURLGroupObject 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/urlgroups ( Test registration of UrlGroup to create a new record )' : value: literals: - type: Url url: www.google.com name: urlgroup_obj1 objects: - id: UrlObjectUUID type: Url type: UrlGroup 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/urlgroups?bulk=true ( Bulk POST operation on url groups. )': value: - literals: - type: Url url: www.google.com name: ug1 objects: - id: url_ObjUuid type: Url type: UrlGroup - literals: - type: Url url: www.cisco.com name: ug2 type: UrlGroup ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/urlgroups?bulk=true ( Bulk POST operation on url groups with overrides )' : value: - description: ' ' id: urlgrp_uuid literals: - type: Url url: www.stackoverflow.com - type: Url url: www.tutorialspoint.com name: urlgrp objects: - id: url_obj_uuid name: url_obj overridable: false type: Url overridable: true overrides: parent: id: urlgrp_uuid type: UrlGroup target: id: domain_uuid name: Global \ EUROPE type: Domain type: UrlGroup - description: ' ' id: urlgrp_uuid literals: - type: Url url: www.stackoverflow.com - type: Url url: www.tutorialspoint.com name: urlgrp overridable: true overrides: parent: id: urlgrp_uuid type: UrlGroup target: id: device_uuid name: FTDv_R1 type: Device type: UrlGroup 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/urlgroups ( POST request to create an override on url group )': value: description: ' ' id: urlgrp1_uuid literals: - type: Url url: www.google.com name: urlgrp1 objects: - id: url1_uuid name: url1 overridable: false type: Url overridable: true overrides: parent: id: urlgrp1_uuid type: UrlGroup target: id: target_uuid name: 10.10.16.29 type: Device type: UrlGroup schema: $ref: '#/components/schemas/URLGroupObject' type: object description: The input url group object model. required: true responses: '201': content: application/json: examples: 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/urlgroups?bulk=true ( Bulk POST operation on url groups. )': value: items: - description: ' ' id: ug1Uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urlgroups/ug1Uuid literals: - type: Url url: www.google.com metadata: domain: id: domainUuid name: Global lastUser: name: pvs timestamp: 0 name: ug1 objects: - id: url_ObjUuid name: UrlObject1 type: Url overridable: false type: UrlGroup - description: ' ' id: ug2Uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urlgroups/ug2Uuid literals: - type: Url url: www.cisco.com metadata: domain: id: domainUuid name: Global lastUser: name: pvs timestamp: 0 name: ug2 overridable: false type: UrlGroup links: self: /api/fmc_config/v1/domain/domainUuid/object/urlgroups?bulk=true ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/urlgroups?bulk=true ( Bulk POST operation on url groups with overrides )' : value: items: - id: urlgrp_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urlgroups/urlgrp_uuid literals: - type: Url url: www.stackoverflow.com - type: Url url: www.tutorialspoint.com metadata: domain: id: domain_uuid name: Global \ EUROPE lastUser: name: pvs timestamp: 0 name: urlgrp objects: - id: url_obj_uuid name: url_obj overridable: false type: Url overridable: true overrides: parent: id: urlgrp_uuid type: UrlGroup target: id: domain_uuid name: Global \ EUROPE type: Domain type: UrlGroup - id: urlgrp_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urlgroups/urlgrp_uuid literals: - type: Url url: www.stackoverflow.com - type: Url url: www.tutorialspoint.com metadata: domain: id: domain_uuid name: Global \ ASIA lastUser: name: pvs timestamp: 0 name: urlgrp objects: - id: url_obj_uuid name: url_obj overridable: false type: Url overridable: true overrides: parent: id: urlgrp_uuid type: UrlGroup target: id: device_uuid name: FTDv_R1 type: Device type: UrlGroup links: self: /api/fmc_config/v1/domain/domainUuid/object/urlgroups?bulk=true 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/urlgroups ( POST request to create an override on url group )': value: id: urlgrp1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urlgroups/urlgrp1_uuid?overrideTargetId=target_uuid literals: - type: Url url: www.google.com metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 0 name: urlgrp1 objects: - id: url1_uuid name: url1 overridable: false type: Url overridable: true overrides: parent: id: urlgrp1_uuid type: UrlGroup target: id: target_uuid name: 10.10.16.29 type: Device type: UrlGroup schema: $ref: '#/components/schemas/URLGroupObject' 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/urlgroups/{containerUUID}/overrides: get: deprecated: false description: '**Get all overrides on the specified URL group. Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored.**' operationId: getAllUrlGroupOverride 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/urlgroups/urlGroupObjectUUID/overrides ( Get all overrides(device and deomain) on Given URLObjectGroup )' : value: items: - description: ' ' id: deviceUUID links: self: /fmc_config/v1/domain/domainUUID/object/urlgroups/urlGroupObjectUUID?overrideTargetId=793710a0-21cf-11e8-9b2b-c8519f5a7ccc metadata: domain: id: domainUUID name: Global \ INDIA \ BENGALURU lastUser: name: user1 timestamp: 1520419908146.0 name: device objects: - id: URLobjectUUID name: url_2 overridable: false type: Url overridable: true overrides: parent: id: UrlGroupUUID type: UrlGroup target: id: targetUUID name: 10.10.19.27 type: Device type: UrlGroup links: self: /fmc_config/v1/domain/domainUUID/object/urlgroups/urlGroupObjectUUID/overrides?offset=0&limit=1 paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/UrlGroupOverrideListContainer' 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/urlgroups/{containerUUID}/overrides/{objectId}: get: deprecated: false description: '**Get all overrides on the specified url group object. Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored.**' operationId: getUrlGroupOverride parameters: - description: Unique identifier of the URL 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/UrlGroupOverride' 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/urlgroups/{objectId}: delete: deprecated: false description: '**Delete the URL group associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteURLGroupObject parameters: - description: Unique identifier of the URL 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/urlgroups/UrlGroupUUID2 ( Test DELETE of UrlGroup Object )': value: id: UrlGroupUUID2 literals: - type: Url url: www.google.com name: urlgroup_obj2 objects: - id: UrlObjectUUID type: Url type: UrlGroup ? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/urlgroups/urlgrp1_uuid?overrideTargetId=target_uuid ( DELETE request to remove an override on url group )' : value: description: ' ' id: urlgrp1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urlgroups/urlgrp1_uuid?overrideTargetId=target_uuid literals: - type: Url url: www.google.com metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 1527360182370.0 name: urlgrp1 objects: - id: url1_uuid name: url1 overridable: false type: Url overridable: true overrides: parent: id: urlgrp1_uuid type: UrlGroup target: id: target_uuid name: 10.10.16.29 type: Device type: UrlGroup schema: $ref: '#/components/schemas/URLGroupObject' 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 URL group associated with the specified ID.**' operationId: getURLGroupObject parameters: - description: Unique identifier of the URL group. in: path name: objectId required: true schema: type: string - description: Get the overrides associated with the specified URL 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/urlgroups/UrlGroupUUID1 ( Test GET of UrlGroup Object for a uuid )': value: id: UrlGroupUUID1 literals: - type: Url url: www.google.com name: urlgroup_obj1 objects: - id: UrlObjectUUID type: Url type: UrlGroup schema: $ref: '#/components/schemas/URLGroupObject' 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 URL group associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateURLGroupObject parameters: - description: Unique identifier of the URL 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/urlgroups/UrlGroupUUID1 ( Test PUT of UrlGroup object to update record )' : value: id: UrlGroupUUID1 literals: - type: Url url: www.google.com name: urlgroup_obj1_updated objects: - id: UrlObjectUUID type: Url type: UrlGroup ? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/urlgroups/urlgrp1_uuid ( PUT request to update an override on url group )' : value: description: ' ' id: urlgrp1_uuid literals: - type: Url url: www.google.com name: urlgrp1 objects: - id: url1_uuid name: url1 overridable: false type: Url overridable: true overrides: parent: id: urlgrp1_uuid type: UrlGroup target: id: target_uuid name: 10.10.16.29 type: Device type: UrlGroup schema: $ref: '#/components/schemas/URLGroupObject' type: object description: The input url group object model. required: true responses: '200': content: application/json: examples: ? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/urlgroups/urlgrp1_uuid ( PUT request to update an override on url group )' : value: id: urlgrp1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urlgroups/urlgrp1_uuid?overrideTargetId=target_uuid literals: - type: Url url: www.google.com metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 0 name: urlgrp1 objects: - id: url1_uuid name: url1 overridable: false type: Url overridable: true overrides: parent: id: urlgrp1_uuid type: UrlGroup target: id: target_uuid name: 10.10.16.29 type: Device type: UrlGroup schema: $ref: '#/components/schemas/URLGroupObject' 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/urls: delete: deprecated: false description: '**Delete all URLs. Use filtering to specfiy which URLs will be deleted. _Check the response section for applicable examples (if any)._**' operationId: deleteMultipleURLObject 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/urls/urlObjectUUID ( Test DELETE of Url Object )': value: description: ' ' id: urlObjectUUID links: self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/urls/urlObjectUUID metadata: domain: id: global_domain_id name: Global lastUser: name: admin name: url_obj1 overridable: false type: Url url: www.cisco.com ? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/urls/url1_uuid?overrideTargetId=target_uuid ( DELETE request to remove an override on url object )' : value: description: ' ' id: url1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urls/url1_uuid?overrideTargetId=target_uuid metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 1527359452310.0 name: url1 overridable: true overrides: parent: id: url1_uuid type: Url target: id: target_uuid name: 10.10.16.29 type: Device type: Url url: www.cisco.com schema: $ref: '#/components/schemas/URLObject' 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 URLs.**' operationId: getAllURLObject 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/urls?expanded=true&overrideTargetId=childDomainUUID ( Success: Test GET ALL method from global domain for UrlObject when overrides are assigned to child domain )' : value: items: - description: ' ' id: urlObjectUUID links: self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/urls/urlObjectUUID metadata: domain: id: subdomain_id name: Global \ Asia lastUser: name: pvs name: pvs_global_url overridable: true overrides: parent: id: urlObjectUUID type: Url target: id: subdomain_id name: Global \ Asia type: Domain type: Url url: www.cisco.com links: self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/urls?offset=0&limit=1 paging: count: 1 limit: 1 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/childDomainUUID/object/urls?expanded=true&overrideTargetId=childDomainUUID ( Success: Test GET ALL method from child domain for UrlObject when overrides are assigned to child domain )' : value: items: - description: ' ' id: urlObjectUUID links: self: https://fmc_host_ip/api/fmc_config/v1/domain/subdomain_id/object/urls/urlObjectUUID metadata: domain: id: subdomain_id name: Global \ Asia lastUser: name: pvs name: pvs_global_url overridable: true overrides: parent: id: urlObjectUUID type: Url target: id: subdomain_id name: Global \ Asia type: Domain type: Url url: www.cisco.com links: self: https://fmc_host_ip/api/fmc_config/v1/domain/subdomain_id/object/urls?offset=0&limit=1 paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/URLObjectListContainer' 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 URL. _Check the response section for applicable examples (if any)._**' operationId: createMultipleURLObject 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/urls?bulk=true ( Bulk POST operation on Url objects. )': value: - description: url object 1 name: UrlObject1 type: Url url: http://wwwin.cisco.com - description: url object 2 name: UrlObject2 type: Url url: http://www.google.com ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/urls?bulk=true ( Bulk POST operation on Url objects with overrides )' : value: - description: ' ' id: url_obj_uuid name: url_obj overridable: true overrides: parent: id: url_obj_uuid type: Url target: id: domain_uuid name: Global \ EUROPE type: Domain type: Url url: www.cisco.com - description: ' ' id: url_obj_uuid name: url_obj overridable: true overrides: parent: id: url_obj_uuid type: Url target: id: device_uuid name: FTDv_R1 type: Device type: Url url: www.facebook.com 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/urls ( POST request to create an override on url object )': value: description: ' ' id: url1_uuid name: url1 overridable: true overrides: parent: id: url1_uuid type: Url target: id: target_uuid name: 10.10.16.29 type: Device type: Url url: www.cisco.com 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/urls ( Success Test POST method for Url Obj )': value: description: object to test FMC implementation name: UrlObject1 overridable: false type: Url url: http://wwwin.cisco.com ? 'Example 6 : POST /fmc_config/v1/domain/DomainUUID/object/urls ( Success: Test POST method for Url Object with special characters. )' : value: description: testing with special characters name: urlobj5 overridable: false type: Url url: http://%#%$ 'Example 7 : POST /fmc_config/v1/domain/DomainUUID/object/urls ( Failure: Passing metadata as a parameter. )': value: description: testing with metadata metadata: readOnly: false name: urlobj6 overridable: false type: Url url: wwwin.cisco.com schema: $ref: '#/components/schemas/URLObject' type: object description: The input url object model. required: true responses: '201': content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/urls?bulk=true ( Bulk POST operation on Url objects. )': value: items: - description: url object 1 id: urlObject1Uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urls/urlObject1Uuid metadata: domain: id: domainUuid name: Global lastUser: name: pvs timestamp: 0 name: UrlObject1 overridable: false type: Url url: http://wwwin.cisco.com - description: url object 2 id: urlObject2Uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urls/urlObject2Uuid metadata: domain: id: domainUuid name: Global lastUser: name: pvs timestamp: 0 name: UrlObject2 overridable: false type: Url url: http://www.google.com links: self: /api/fmc_config/v1/domain/domainUuid/object/urls?bulk=true ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/urls?bulk=true ( Bulk POST operation on Url objects with overrides )' : value: items: - id: url_obj_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urls/url_obj_uuid metadata: domain: id: domain_uuid name: Global \ EUROPE lastUser: name: pvs timestamp: 0 name: url_obj overridable: true overrides: parent: id: url_obj_uuid type: Url target: id: domain_uuid name: Global \ EUROPE type: Domain type: Url url: www.cisco.com - id: url_obj_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urls/url_obj_uuid metadata: domain: id: domain_uuid name: Global \ ASIA lastUser: name: pvs timestamp: 0 name: url_obj overridable: true overrides: parent: id: url_obj_uuid type: Url target: id: device_uuid name: FTDv_R1 type: Device type: Url url: www.facebook.com links: self: /api/fmc_config/v1/domain/domainUuid/object/urls?bulk=true 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/urls ( POST request to create an override on url object )': value: id: url1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urls/url1_uuid?overrideTargetId=target_uuid metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 0 name: url1 overridable: true overrides: parent: id: url1_uuid type: Url target: id: target_uuid name: 10.10.16.29 type: Device type: Url url: www.cisco.com schema: $ref: '#/components/schemas/URLObject' type: object description: Created '422': content: application/json: examples: 'Example 7 : POST /fmc_config/v1/domain/DomainUUID/object/urls ( Failure: Passing metadata as a parameter. )': value: error: category: OTHER messages: - description: Unprocessable Entity severity: ERROR schema: $ref: '#/components/schemas/URLObject' type: object description: Unprocessable Entity 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/urls/{containerUUID}/overrides: get: deprecated: false description: '**Get all overrides on the specified URL. Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored.**' operationId: getAllUrlOverride 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/urls/urlUUID/overrides ( Get all overrides on given URL objects )': value: items: - description: ' ' id: urlUUID links: self: /fmc_config/v1/domain/domainUUID/object/urls/urlUUID?overrideTargetId=targetUUID metadata: domain: id: domainUUID name: Global \ INDIA \ BENGALURU lastUser: name: user1 timestamp: 1520419867090.0 name: url_2 overridable: true overrides: parent: id: urlUUID type: Url target: id: targetUUID name: 10.10.19.27 type: Device type: Url url: abcDevice.com links: self: /fmc_config/v1/domain/domainUUID/object/urls/urlUUID/overrides?offset=0&limit=1 paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/UrlOverrideListContainer' 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/urls/{containerUUID}/overrides/{objectId}: get: deprecated: false description: '**Get all overrides on the specified url object. Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored.**' operationId: getUrlOverride parameters: - description: Unique identifier of the URL 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/UrlOverride' 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/urls/{objectId}: delete: deprecated: false description: '**Delete the URL associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteURLObject parameters: - description: Unique identifier of the URL. 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/urls/urlObjectUUID ( Test DELETE of Url Object )': value: description: ' ' id: urlObjectUUID links: self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/urls/urlObjectUUID metadata: domain: id: global_domain_id name: Global lastUser: name: admin name: url_obj1 overridable: false type: Url url: www.cisco.com ? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/urls/url1_uuid?overrideTargetId=target_uuid ( DELETE request to remove an override on url object )' : value: description: ' ' id: url1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urls/url1_uuid?overrideTargetId=target_uuid metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 1527359452310.0 name: url1 overridable: true overrides: parent: id: url1_uuid type: Url target: id: target_uuid name: 10.10.16.29 type: Device type: Url url: www.cisco.com schema: $ref: '#/components/schemas/URLObject' 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 URL associated with the specified ID.**' operationId: getURLObject parameters: - description: Unique identifier of the URL. in: path name: objectId required: true schema: type: string - description: Get the overrides associated with the specified URL. 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/urls/urlObjectUUID?expanded=true&overrideTargetId=childDomainUUID ( Success: Test GET method from global domain on a specific UrlObject which has override assigned as child domain )' : value: description: ' ' id: urlObjectUUID links: self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/urls/urlObjectUUID metadata: domain: id: subdomain_id name: Global \ Asia lastUser: name: pvs name: pvs_global_url overridable: true overrides: parent: id: urlObjectUUID type: Url target: id: subdomain_id name: Global \ Asia type: Domain type: Url url: www.cisco.com ? 'Example 2 : GET /fmc_config/v1/domain/childDomainUUID/object/urls/urlObjectUUID?expanded=true&overrideTargetId=childDomainUUID ( Success: Test GET method from child domain on a UrlObject which has child domain assigned as override )' : value: description: ' ' id: urlObjectUUID links: self: https://fmc_host_ip/api/fmc_config/v1/domain/subdomain_id/object/urls/urlObjectUUID metadata: domain: id: subdomain_id name: Global \ Asia lastUser: name: pvs name: pvs_global_url overridable: true overrides: parent: id: urlObjectUUID type: Url target: id: subdomain_id name: Global \ Asia type: Domain type: Url url: www.cisco.com ? 'Example 3 : GET /fmc_config/v1/domain/childDomainUUID/object/urls/urlObjectUUID?expanded=true&overrideTargetId=deviceUUID ( Success: Test GET method from child domain on a UrlObject which has device assigned as override )' : value: description: ' ' id: urlObjectUUID links: self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/urls/urlObjectUUID metadata: domain: id: subdomain_id name: Global \ Asia lastUser: name: api name: G-Url1 overridable: true overrides: parent: id: urlObjectUUID type: Url target: id: deviceUUID name: device_name type: Device type: Url url: g-device-url1.com schema: $ref: '#/components/schemas/URLObject' 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 URL associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateURLObject parameters: - description: Unique identifier of the URL. 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/urls/url1_uuid ( PUT request to update an override on url object )': value: description: ' ' id: url1_uuid name: url1 overridable: true overrides: parent: id: url1_uuid type: Url target: id: target_uuid name: 10.10.16.29 type: Device type: Url url: www.cisco.com schema: $ref: '#/components/schemas/URLObject' type: object description: The input url object model. required: true responses: '200': content: application/json: examples: 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/urls/url1_uuid ( PUT request to update an override on url object )': value: id: url1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/urls/url1_uuid?overrideTargetId=target_uuid metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 0 name: url1 overridable: true overrides: parent: id: url1_uuid type: Url target: id: target_uuid name: 10.10.16.29 type: Device type: Url url: www.cisco.com schema: $ref: '#/components/schemas/URLObject' 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/validatecertfile: post: deprecated: false description: '**Upload and parse a given certificate/key file. _Check the response section for applicable examples (if any)._**' operationId: createValidateCertFile parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: multipart/form-data: examples: 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/validatecertfile ( Example of Certificate file validation. )': value: fileType: CERT payloadFile: X.509 Certificate file 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/object/validatecertfile ( Example of Private Key file upload. )': value: fileType: KEY payloadFile: Private key file schema: properties: fileType: description: The type of the file. Must be either CERT or KEY. *required type: string payloadFile: description: The actual file to be uploaded. *required format: binary type: string type: object responses: '201': content: application/json: examples: 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/validatecertfile ( Example of Certificate file validation. )': value: 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----- ' fileName: 1024b-rsa-example-cert.der_1646421905587 fileType: CERT 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/object/validatecertfile ( Example of Private Key file upload. )': value: fileName: 1024b-rsa-example-keypair.der_1646422014229 fileType: KEY privateKey: 'REDACTED_PRIVATE_KEY_EXAMPLE ' schema: $ref: '#/components/schemas/ValidateCertFile' 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/variables: get: deprecated: false description: '**Get the list of all variables for device templates.**' operationId: getAllVariable parameters: - description: Name or part of the name of the variables. 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 /api/fmc_config/v1/domain/DomainUUID/object/variables ( Get all variable objects )': value: items: - id: 00000000-0000-0ed3-0000-012884907058 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin1 timestamp: 1706786020209.0 name: IPV4 type: Variable variableType: IPV4_HOST - id: 00000000-0000-0ed3-0000-012884907076 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin1 timestamp: 1706786059435.0 name: IPV4_NETWORK type: Variable variableType: IPV4_NETWORK links: self: api/fmc_config/v1/domain/DomainUUID/object/variables schema: $ref: '#/components/schemas/VariableListContainer' 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 variable for device templates. A variable defines specific configuration values in a template and can be of types AS number, FQDN, IPv4/IPv6 host, IPv4/IPv6 network, IPv4 range, password, router ID, and custom strings. _Check the response section for applicable examples (if any)._**' operationId: createVariable 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/variables ( Add a variable object )': value: name: IPV4Object type: Variable variableType: IPV4_HOST schema: $ref: '#/components/schemas/Variable' type: object description: Input representation of variable. required: true responses: '201': content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/variables ( Add a variable object )': value: id: 00000000-0000-0ed3-0000-090194313304 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin1 timestamp: 0 name: IPV4Object type: Variable variableType: IPV4_HOST schema: $ref: '#/components/schemas/Variable' 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/variables/{objectId}: delete: deprecated: false description: '**Delete the specified device template variable. _Check the response section for applicable examples (if any)._**' operationId: deleteVariable parameters: - description: Unique identifier of the device template variable. 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/variables/objectId ( Delete a variable object )': value: id: 00000000-0000-0ed3-0000-012884907076 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin1 timestamp: 1706786059435.0 name: IPV4_NETWORK type: Variable variableType: IPV4_NETWORK schema: $ref: '#/components/schemas/Variable' 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 device template variable.**' operationId: getVariable parameters: - description: Unique identifier of the device template variable. 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/variables/objectId ( Get a variable object )': value: id: 00000000-0000-0ed3-0000-012884907058 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin1 timestamp: 1706786020209.0 name: IPV4 type: Variable variableType: IPV4_HOST schema: $ref: '#/components/schemas/Variable' 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 device template variable. _Check the response section for applicable examples (if any)._**' operationId: updateVariable parameters: - description: Unique identifier of the device template variable. 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/variables/objectId ( Put of variable to update a variable object )': value: id: 00000000-0000-0ed3-0000-012884907058 name: IPV4_Obj type: Variable variableType: IPV4_HOST schema: $ref: '#/components/schemas/Variable' type: object description: Input representation of variable. required: true responses: '200': content: application/json: examples: 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/variables/objectId ( Put of variable to update a variable object )': value: id: 00000000-0000-0ed3-0000-012884907058 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin1 timestamp: 0 name: IPV4_Obj type: Variable variableType: IPV4_HOST schema: $ref: '#/components/schemas/Variable' 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/variablesets: get: deprecated: false description: '**Get the list of all variable sets.**' operationId: getAllVariableSet 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/variablesets ( Success: Test GET ALL success of a variable set )': value: items: - id: Variable-Set-UUID-1 links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/variablesets/Variable-Set-UUID-1 name: Default-Set-TestDomain type: variableset - id: Variable-Set-UUID-2 links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/variablesets/Variable-Set-UUID-2 name: Default-Set type: variableset links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/variablesets?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/object/variablesets?expanded=true ( Success: Test GET ALL success with expanded=true )' : value: items: - description: This Variable Set is system-provided. excluded: literals: - 5.6.7.9 referenceObjects: - id: 0050568A-8384-0ed3-0000-017179870433 name: customExcludedNetworkObject type: Host variables: - DNS_SERVERS id: Variable-Set-UUID-1 included: literals: - 5.6.7.8 - 1.1.1.1 referenceObjects: - id: 0050568A-8384-0ed3-0000-017179870200 name: customIncludedNetworkObject type: Host variables: - HOME_NET - VAR_NET links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/variablesets/Variable-Set-UUID-1 metadata: domain: id: domainUUID name: TestDomain type: domain lastUser: id: User-UUID name: admin type: user readOnly: state: true timestamp: 1460056664.0 name: Default-Set-TestDomain systemDefined: false type: ipvar - description: This Variable Set is system-provided. excluded: literals: - 5.6.7.9 referenceObjects: - id: 0050568A-8384-0ed3-0000-017179870433 name: customExcludedNetworkObject type: Host variables: - DNS_SERVERS id: Variable-Set-UUID-2 included: literals: - 5.6.7.8 - 1.1.1.1 referenceObjects: - id: 0050568A-8384-0ed3-0000-017179870200 name: customIncludedNetworkObject type: Host variables: - HOME_NET - VAR_NET links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/variablesets/Variable-Set-UUID-2 metadata: domain: id: Global-domain-UUID name: Global type: domain lastUser: id: User-UUID name: admin type: user readOnly: state: false timestamp: 1460057664.0 name: Default-Set systemDefined: false type: ipvar links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/variablesets?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/VariableSetListContainer' 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/variablesets/{objectId}: get: deprecated: false description: '**Get the variable set associated with the specified ID.**' operationId: getVariableSet parameters: - description: Unique identifier of the variable set. 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/variablesets/Variable-Set-UUID-1 ( Success: Test GET success of a variable set )' : value: description: This Variable Set is system-provided. id: Variable-Set-UUID-1 links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/variablesets/Variable-Set-UUID-1 metadata: domain: id: domainUUID name: TestDomain type: domain lastUser: id: User-UUID name: admin type: user readOnly: state: true timestamp: 1460056664.0 name: Default-Set-TestDomain type: variableset schema: $ref: '#/components/schemas/VariableSet' 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/vlangrouptags: delete: deprecated: false description: '**Delete all VLAN group tags. Use filtering to specfiy which VLAN group tags will be deleted. _Check the response section for applicable examples (if any)._**' operationId: deleteMultipleVlanTagGroup 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/vlangrouptags/vlanGroupObjectUUID ( Test DELETE of VlanGroup Object )' : value: id: vlanGroupObjectUUID literals: - endTag: valid_tag startTag: valid_tag type: Vlan name: vlangroup_obj objects: - id: vlanObjectUUID type: VlanTag type: VlanGroupTag ? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/vlangrouptags/vlangrp1_uuid?overrideTargetId=target_uuid ( DELETE request to remove an override on vlan group )' : value: description: ' ' id: vlangrp1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlangrouptags/vlangrp1_uuid?overrideTargetId=target_uuid literals: - endTag: 200 startTag: 100 type: VlanTagLiteral metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 1527362407546.0 name: vlangrp1 objects: - data: endTag: 20 startTag: 10 type: VlanTagLiteral id: vlan1_uuid name: vlan1 overridable: false type: VlanTag overridable: true overrides: parent: id: vlangrp1_uuid type: VlanGroupTag target: id: target_uuid name: 10.10.16.29 type: Device type: VlanGroupTag schema: $ref: '#/components/schemas/VlanTagGroup' 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 VLAN group tags.**' operationId: getAllVlanTagGroup 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/DomainUUID/object/vlangrouptags ( Get all paginated vlangroup objects without offset and limit )' : value: items: - id: vlanGroupObjUUID1 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/vlangrouptags/vlanGroupObjUUID1 name: vlan_group1 type: VlanTag - id: vlanGroupObjUUID2 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/vlangrouptags/vlanGroupObjUUID2 name: vlan_group23 type: VlanTag - id: vlanGroupObjUUID3 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/vlangrouptags/vlanGroupObjUUID3 name: vlan_group24 type: VlanTag links: self: https://fmc_host_ip/api/fmc_config/v1/domain/global/object/vlangrouptags?offset=0&limit=3 paging: count: 3 limit: 3 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/vlangrouptags?overrideTargetId=target_uuid ( Get all objects with given override target )' : value: items: - description: ' ' id: vlangrp1_uuid links: self: /api/fmc_config/v1/domain/domain_uuid/object/vlangrouptags/vlangrp1_uuid?overrideTargetId=target_uuid literals: - endTag: 200 startTag: 100 type: VlanTagLiteral metadata: domain: id: domainUuid name: Global \ ASIA \ INDIA lastUser: name: admin timestamp: 1528267362103.0 name: vlangrp1 objects: - data: endTag: 20 startTag: 10 type: VlanTagLiteral id: vlan1_uuid name: vlan1 overridable: false type: VlanTag overridable: true overrides: parent: id: vlangrp1_uuid type: VlanGroupTag target: id: target_uuid name: 10.10.16.29 type: Device type: VlanGroupTag links: self: /api/fmc_config/v1/domain/domain_uuid/object/vlangrouptags?offset=0&limit=1&overrideTargetId=target_uuid&expanded=true paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/VlanTagGroupListContainer' 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 VLAN group tag. _Check the response section for applicable examples (if any)._**' operationId: createMultipleVlanTagGroup 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/vlangrouptags ( Example POST data for VlanGroupTag )': value: description: description_about_group literals: - endTag: valid_tag startTag: valid_tag type: VlanTagLiteral name: vlangroup_obj_1 objects: - data: endTag: valid_tag startTag: valid_tag type: VlanTagLiteral id: vlantagObjectUUID name: Tag1 type: VlanTag overridable: true/false type: VlanGroupTag ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/vlangrouptags?bulk=true ( Bulk POST operation on vlan group tags )' : value: - description: description_about_group literals: - endTag: 345 startTag: 123 type: VlanTagLiteral name: vlangroup_obj_1 objects: - id: vlan_obj1Uuid type: VlanTag type: VlanGroupTag - description: some description literals: - endTag: 789 startTag: 456 type: VlanTagLiteral name: vlangroup_obj_2 objects: - id: vlan_obj1Uuid type: VlanTag type: VlanGroupTag ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/vlangrouptags?bulk=true ( Bulk POST operation on vlan group tags with overrides )' : value: - description: ' ' id: vlan_grp_uuid name: vlan_grp objects: - data: endTag: 13 startTag: 12 type: VlanTagLiteral id: vlantag_obj_uuid name: vlantag_obj overridable: false type: VlanTag overridable: true overrides: parent: id: vlan_grp_uuid type: VlanGroupTag target: id: domain_uuid name: Global \ EUROPE type: Domain type: VlanGroupTag - description: ' ' id: vlan_grp_uuid literals: - endTag: 80 startTag: 59 type: VlanTagLiteral name: vlan_grp overridable: true overrides: parent: id: vlan_grp_uuid type: VlanGroupTag target: id: device_uuid name: FTDv_R1 type: Device type: VlanGroupTag ? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/vlangrouptags ( POST request to create an override on vlan group tag )' : value: description: ' ' id: vlangrp1_uuid literals: - endTag: 200 startTag: 100 type: VlanTagLiteral name: vlangrp1 objects: - data: endTag: 20 startTag: 10 type: VlanTagLiteral id: vlan1_uuid name: vlan1 overridable: false type: VlanTag overridable: true overrides: parent: id: vlangrp1_uuid type: VlanGroupTag target: id: target_uuid name: 10.10.16.29 type: Device type: VlanGroupTag ? 'Example 5 : POST /fmc_config/v1/domain/DomainUUID/object/vlangrouptags ( Test POST of Vlan group tag to create a new record )' : value: description: first VlanGroupTag literals: - endTag: 222 startTag: 111 - endTag: 333 startTag: 222 name: VlanGroupTag_1 objects: - id: vlantagUUID name: VlanTag_1 type: VlanTag - id: vlantagUUID name: VlanTag_2 type: VlanTag type: VlanGroupTag schema: $ref: '#/components/schemas/VlanTagGroup' type: object description: The input vlan group tag object model. required: true responses: '201': content: application/json: examples: ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/vlangrouptags?bulk=true ( Bulk POST operation on vlan group tags )' : value: items: - description: description_about_group id: vlangroup_obj_1Uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlangrouptags/vlangroup_obj_1Uuid literals: - endTag: 345 startTag: 123 type: VlanTagLiteral metadata: domain: id: domainUuid name: Global lastUser: name: pvs timestamp: 0 name: vlangroup_obj_1 objects: - id: vlan_obj1Uuid name: vlanobj1 type: VlanTag overridable: false type: VlanGroupTag - description: some description id: vlangroup_obj_2Uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlangrouptags/vlangroup_obj_2Uuid literals: - endTag: 789 startTag: 456 type: VlanTagLiteral metadata: domain: id: domainUuid name: Global lastUser: name: pvs timestamp: 0 name: vlangroup_obj_2 objects: - id: vlan_obj1Uuid name: vlanobj1 type: VlanTag overridable: false type: VlanGroupTag links: self: /api/fmc_config/v1/domain/domainUuid/object/vlangrouptags?bulk=true ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/vlangrouptags?bulk=true ( Bulk POST operation on vlan group tags with overrides )' : value: items: - id: vlan_grp_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlangrouptags/vlan_grp_uuid metadata: domain: id: domain_uuid name: Global \ EUROPE lastUser: name: pvs timestamp: 0 name: vlan_grp objects: - data: endTag: 13 startTag: 12 type: VlanTagLiteral id: vlantag_obj_uuid name: vlantag_obj overridable: false type: VlanTag overridable: true overrides: parent: id: vlan_grp_uuid type: VlanGroupTag target: id: domain_uuid name: Global \ EUROPE type: Domain type: VlanGroupTag - id: vlan_grp_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlangrouptags/vlan_grp_uuid literals: - endTag: 80 startTag: 59 type: VlanTagLiteral metadata: domain: id: domain_uuid name: Global \ ASIA lastUser: name: pvs timestamp: 0 name: vlan_grp objects: - data: endTag: 13 startTag: 12 type: VlanTagLiteral id: vlantag_obj_uuid name: vlantag_obj overridable: false type: VlanTag overridable: true overrides: parent: id: vlan_grp_uuid type: VlanGroupTag target: id: device_uuid name: FTDv_R1 type: Device type: VlanGroupTag links: self: /api/fmc_config/v1/domain/domainUuid/object/vlangrouptags?bulk=true ? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/vlangrouptags ( POST request to create an override on vlan group tag )' : value: id: vlangrp1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlangrouptags/vlangrp1_uuid?overrideTargetId=target_uuid literals: - endTag: 200 startTag: 100 type: VlanTagLiteral metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 0 name: vlangrp1 objects: - data: endTag: 20 startTag: 10 type: VlanTagLiteral id: vlan1_uuid name: vlan1 overridable: false type: VlanTag overridable: true overrides: parent: id: vlangrp1_uuid type: VlanGroupTag target: id: target_uuid name: 10.10.16.29 type: Device type: VlanGroupTag schema: $ref: '#/components/schemas/VlanTagGroup' 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/vlangrouptags/{containerUUID}/overrides: get: deprecated: false description: '**Get all overrides on the specified VLAN group tag. Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored.**' operationId: getAllVlanTagGroupOverride 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/vlangrouptags/valnGroupTagUUID/overrides ( Get all overrides(device and deomain) on Given VlanGroup tags )' : value: items: - description: ' ' id: valnGroupTagUUID1 links: self: /fmc_config/v1/domain/domainUUID/object/vlangrouptags/valnGroupTagUUID?overrideTargetId=targetUUID metadata: domain: id: domainUUID name: Global \ INDIA \ BENGALURU lastUser: name: user1 timestamp: 1520420232013.0 name: vlan_grp objects: - data: endTag: 20 startTag: 20 type: VlanTagLiteral id: vlanObjectUUID name: Vlan_2 overridable: false type: VlanTag overridable: true overrides: parent: id: valnGroupTagUUID1 type: VlanGroupTag target: id: targetUUID name: 10.10.19.27 type: Device type: VlanGroupTag links: self: /fmc_config/v1/domain/domainUUID/object/vlangrouptags/valnGroupTagUUID/overrides?offset=0&limit=1 paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/VlanTagGroupOverrideListContainer' 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/vlangrouptags/{containerUUID}/overrides/{objectId}: get: deprecated: false description: '**Get all overrides on the specified VLAN group tag object. Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored.**' operationId: getVlanTagGroupOverride parameters: - description: Unique identifier of the VLAN group tag 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/VlanTagGroupOverride' 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/vlangrouptags/{objectId}: delete: deprecated: false description: '**Delete the VLAN group tag associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteVlanTagGroup parameters: - description: Unique identifier of the VLAN group tag. 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/vlangrouptags/vlanGroupObjectUUID ( Test DELETE of VlanGroup Object )' : value: id: vlanGroupObjectUUID literals: - endTag: valid_tag startTag: valid_tag type: Vlan name: vlangroup_obj objects: - id: vlanObjectUUID type: VlanTag type: VlanGroupTag ? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/vlangrouptags/vlangrp1_uuid?overrideTargetId=target_uuid ( DELETE request to remove an override on vlan group )' : value: description: ' ' id: vlangrp1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlangrouptags/vlangrp1_uuid?overrideTargetId=target_uuid literals: - endTag: 200 startTag: 100 type: VlanTagLiteral metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 1527362407546.0 name: vlangrp1 objects: - data: endTag: 20 startTag: 10 type: VlanTagLiteral id: vlan1_uuid name: vlan1 overridable: false type: VlanTag overridable: true overrides: parent: id: vlangrp1_uuid type: VlanGroupTag target: id: target_uuid name: 10.10.16.29 type: Device type: VlanGroupTag schema: $ref: '#/components/schemas/VlanTagGroup' 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 VLAN group tag associated with the specified ID.**' operationId: getVlanTagGroup parameters: - description: Unique identifier of the VLAN group tag. in: path name: objectId required: true schema: type: string - description: Get the overrides associated with the specified VLAN group tag. 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/vlangrouptags/vlanGroupObj1UUID ( Test GET of VlanGroupTag Object for a uuid )' : value: description: description_about_group id: vlanGroupObj1UUID literals: - endTag: valid_tag startTag: valid_tag type: Vlan name: vlangroup_obj1 objects: - id: vlanObjectUUID type: VlanTag type: VlanGroupTag schema: $ref: '#/components/schemas/VlanTagGroup' 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 VLAN group tag associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateVlanTagGroup parameters: - description: Unique identifier of the VLAN group tag. 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/vlangrouptags/vlanGroupObj1UUID ( Test PUT of VlanGroupTag object to update record )' : value: id: vlanGroupObj1UUID literals: - endTag: valid_tag startTag: valid_tag type: Vlan name: vlangroup_obj1_updated objects: - id: vlanObjectUUID type: VlanTag type: VlanGroupTag ? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/vlangrouptags/vlangrp1_uuid ( PUT request to update an override on vlan group tag )' : value: description: ' ' id: vlangrp1_uuid literals: - endTag: 200 startTag: 100 type: VlanTagLiteral name: vlangrp1 objects: - data: endTag: 20 startTag: 10 type: VlanTagLiteral id: vlan1_uuid name: vlan1 overridable: false type: VlanTag overridable: true overrides: parent: id: vlangrp1_uuid type: VlanGroupTag target: id: target_uuid name: 10.10.16.29 type: Device type: VlanGroupTag schema: $ref: '#/components/schemas/VlanTagGroup' type: object description: The input vlan group tag object model. required: true responses: '200': content: application/json: examples: ? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/vlangrouptags/vlangrp1_uuid ( PUT request to update an override on vlan group tag )' : value: id: vlangrp1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlangrouptags/vlangrp1_uuid?overrideTargetId=target_uuid literals: - endTag: 200 startTag: 100 type: VlanTagLiteral metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 0 name: vlangrp1 objects: - data: endTag: 20 startTag: 10 type: VlanTagLiteral id: vlan1_uuid name: vlan1 overridable: false type: VlanTag overridable: true overrides: parent: id: vlangrp1_uuid type: VlanGroupTag target: id: target_uuid name: 10.10.16.29 type: Device type: VlanGroupTag schema: $ref: '#/components/schemas/VlanTagGroup' 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/vlantags: delete: deprecated: false description: '**Delete all VLAN tags. Use filtering to specify which VLAN tags will be deleted. _Check the response section for applicable examples (if any)._**' operationId: deleteMultipleVlanTag 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: Enables bulk create for vlan tag objects. 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/vlantags/vlantagObjectUUID ( Test DELETE of VlanTag Object )': value: data: endTag: 3 startTag: 1 type: VlanTagLiteral description: ' ' id: vlanObject1UUID links: self: /fmc_config/v1/domain/global/object/vlantags/vlanObject1UUID metadata: domain: id: globalDomainUUID name: Global lastUser: name: admin name: vlan_obj1 overridable: false type: VlanTag ? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/vlantags/vlan1_uuid?overrideTargetId=target_uuid ( DELETE request to remove an override on vlan tag object )' : value: data: endTag: 20 startTag: 10 type: VlanTagLiteral description: ' ' id: vlan1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlantags/vlan1_uuid?overrideTargetId=target_uuid metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 1527361559670.0 name: vlan1 overridable: true overrides: parent: id: vlan1_uuid type: VlanTag target: id: target_uuid name: 10.10.16.29 type: Device type: VlanTag schema: $ref: '#/components/schemas/VlanTag' 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 VLAN tags.**' operationId: getAllVlanTag 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/vlantags?expanded=true&overrideTargetId=childDomainUUID ( Success: Test GET ALL method from global domain for VlanTagObject when overrides are assigned to child domain )' : value: items: - data: endTag: 13 startTag: 13 type: VlanTagLiteral description: ' ' id: vlanObjectUUID links: self: /fmc_config/v1/domain/global/object/vlantags/vlanObjectUUID metadata: domain: id: subDomainUUID name: Global \ Asia lastUser: name: pvs name: pvs_vlan overridable: true overrides: parent: id: vlanObjectUUID type: VlanTag target: id: subDomainUUID name: Global \ Asia type: Domain type: VlanTag links: self: /fmc_config/v1/domain/global/object/vlantags?offset=0&limit=1 paging: count: 1 limit: 1 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/childDomainUUID/object/vlantags?expanded=true&overrideTargetId=childDomainUUID ( Success: Test GET ALL method from child domain for VlanTagObject when overrides are assigned to child domain )' : value: items: - data: endTag: 13 startTag: 13 type: VlanTagLiteral description: ' ' id: vlanObjectUUID links: self: /fmc_config/v1/domain/subDomainUUID/object/vlantags/vlanObjectUUID metadata: domain: id: subDomainUUID name: Global \ Asia lastUser: name: pvs name: pvs_vlan overridable: true overrides: parent: id: vlanObjectUUID type: VlanTag target: id: subDomainUUID name: Global \ Asia type: Domain type: VlanTag links: self: /fmc_config/v1/domain/subDomainUUID/object/vlantags?offset=0&limit=1 paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/VlanTagListContainer' 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 VLAN tag. _Check the response section for applicable examples (if any)._**' operationId: createMultipleVlanTag parameters: - description: Enables bulk create for vlan tag objects. 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/vlantags?bulk=true ( Bulk POST operation on vlan tag objects. )': value: - data: endTag: 15 startTag: 12 description: New VlanTag test name: vlanobj1 type: VlanTag - data: endTag: 151 startTag: 112 description: New VlanTag test name: vlanobj2 type: VlanTag ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/vlantags?bulk=true ( Bulk POST operation on vlan tag objects with overrides )' : value: - data: endTag: 30 startTag: 25 type: VlanTagLiteral description: ' ' id: vlantag_obj_uuid name: vlantag_obj overridable: true overrides: parent: id: vlantag_obj_uuid type: VlanTag target: id: domain_uuid name: Global \ EUROPE type: Domain type: VlanTag - data: endTag: 3000 startTag: 55 type: VlanTagLiteral description: ' ' id: vlantag_obj_uuid name: vlantag_obj overridable: true overrides: parent: id: vlantag_obj_uuid type: VlanTag target: id: device_uuid name: FTDv_R1 type: Device type: VlanTag ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/vlantags ( POST request to create an override on vlan tag object )' : value: data: endTag: 20 startTag: 10 type: VlanTagLiteral description: ' ' id: vlan1_uuid name: vlan1 overridable: true overrides: parent: id: vlan1_uuid type: VlanTag target: id: target_uuid name: 10.10.16.29 type: Device type: VlanTag 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/object/vlantags ( Success Test POST method for Vlan Tag )': value: data: endTag: 15 startTag: 12 description: New VlanTag test name: OnenewVlanTag1 overridable: false type: VlanTag schema: $ref: '#/components/schemas/VlanTag' type: object description: The input VLAN tag object model. required: true responses: '201': content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/vlantags?bulk=true ( Bulk POST operation on vlan tag objects. )': value: items: - data: endTag: 15 startTag: 12 type: VlanTagLiteral description: New VlanTag test id: vlanObj1Uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlantags/vlanObj1Uuid metadata: domain: id: domainUuid name: Global lastUser: name: pvs timestamp: 0 name: vlanobj1 overridable: false type: VlanTag - data: endTag: 151 startTag: 112 type: VlanTagLiteral description: New VlanTag test id: vlanobj2Uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlantags/vlanobj2Uuid metadata: domain: id: domainUuid name: Global lastUser: name: pvs timestamp: 0 name: vlanobj2 overridable: false type: VlanTag links: self: /api/fmc_config/v1/domain/domainUuid/object/vlantags?bulk=true ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/vlantags?bulk=true ( Bulk POST operation on vlan tag objects with overrides )' : value: items: - data: endTag: 30 startTag: 25 type: VlanTagLiteral id: vlantag_obj_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlantags/vlantag_obj_uuid metadata: domain: id: domain_uuid name: Global \ EUROPE lastUser: name: pvs timestamp: 0 name: vlantag_obj overridable: true overrides: parent: id: vlantag_obj_uuid type: VlanTag target: id: domain_uuid name: Global \ EUROPE type: Domain type: VlanTag - data: endTag: 3000 startTag: 55 type: VlanTagLiteral id: vlantag_obj_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlantags/vlantag_obj_uuid metadata: domain: id: domain_uuid name: Global \ ASIA lastUser: name: pvs timestamp: 0 name: vlantag_obj overridable: true overrides: parent: id: vlantag_obj_uuid type: VlanTag target: id: device_uuid name: FTDv_R1 type: Device type: VlanTag links: self: /api/fmc_config/v1/domain/domainUuid/object/vlantags?bulk=true ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/vlantags ( POST request to create an override on vlan tag object )' : value: data: endTag: 20 startTag: 10 type: VlanTagLiteral id: vlan1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlantags/vlan1_uuid?overrideTargetId=target_uuid metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 0 name: vlan1 overridable: true overrides: parent: id: vlan1_uuid type: VlanTag target: id: target_uuid name: 10.10.16.29 type: Device type: VlanTag schema: $ref: '#/components/schemas/VlanTag' 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/vlantags/{containerUUID}/overrides: get: deprecated: false description: '**Get all overrides on the specified VLAN tag. Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored.**' operationId: getAllVlanOverride 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/vlantags/vlanTagUUID/overrides ( Get all overrides on given VlanTag objects )' : value: items: - data: endTag: 13 startTag: 13 type: VlanTagLiteral description: ' ' id: vlanTagUUID links: self: /fmc_config/v1/domain/domainUUID/object/vlantags/vlanTagUUID?overrideTargetId=targetUUID metadata: domain: id: targetUUID name: Global \ INDIA \ BENGALURU lastUser: name: user1 timestamp: 1520419179300.0 name: vlan_1 overridable: true overrides: parent: id: vlanTagUUID type: VlanTag target: id: targetUUID name: Global \ INDIA \ BENGALURU type: Domain type: VlanTag - data: endTag: 14 startTag: 14 type: VlanTagLiteral description: ' ' id: vlanTagUUID links: self: /fmc_config/v1/domain/domainUUID/object/vlantags/vlanTagUUID?overrideTargetId=targetUUID metadata: domain: id: targetUUID name: Global \ INDIA \ PUNE lastUser: name: user1 timestamp: 1520419189983.0 name: vlan_1 overridable: true overrides: parent: id: vlanTagUUID type: VlanTag target: id: targetUUID name: Global \ INDIA \ PUNE type: Domain type: VlanTag links: self: /fmc_config/v1/domain/domainUUID/object/vlantags/vlanTagUUID/overrides?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/VlanOverrideListContainer' 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/vlantags/{containerUUID}/overrides/{objectId}: get: deprecated: false description: '**Get all overrides on the specified VLAN object. Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored.**' operationId: getVlanOverride parameters: - description: Unique identifier of the VLAN override tag. 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/VlanOverride' 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/vlantags/{objectId}: delete: deprecated: false description: '**Delete the VLAN tag associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteVlanTag parameters: - description: Unique identifier of the VLAN tag. 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/vlantags/vlantagObjectUUID ( Test DELETE of VlanTag Object )': value: data: endTag: 3 startTag: 1 type: VlanTagLiteral description: ' ' id: vlanObject1UUID links: self: /fmc_config/v1/domain/global/object/vlantags/vlanObject1UUID metadata: domain: id: globalDomainUUID name: Global lastUser: name: admin name: vlan_obj1 overridable: false type: VlanTag ? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/object/vlantags/vlan1_uuid?overrideTargetId=target_uuid ( DELETE request to remove an override on vlan tag object )' : value: data: endTag: 20 startTag: 10 type: VlanTagLiteral description: ' ' id: vlan1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlantags/vlan1_uuid?overrideTargetId=target_uuid metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 1527361559670.0 name: vlan1 overridable: true overrides: parent: id: vlan1_uuid type: VlanTag target: id: target_uuid name: 10.10.16.29 type: Device type: VlanTag schema: $ref: '#/components/schemas/VlanTag' 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 VLAN tag associated with the specified ID.**' operationId: getVlanTag parameters: - description: Unique identifier of the VLAN tag. in: path name: objectId required: true schema: type: string - description: Get the overrides associated with the specified VLAN tag. 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/vlantags/vlan_object_uuid?expanded=true&overrideTargetId=childDomainUUID ( Success: Test GET method from global domain on a specific VlanTagObject which has override assigned as child domain )' : value: data: endTag: 13 startTag: 13 type: VlanTagLiteral description: ' ' id: vlanObjectUUID links: self: /fmc_config/v1/domain/global/object/vlantags/vlanObjectUUID metadata: domain: id: subDomainUUID name: Global \ Asia lastUser: name: pvs name: pvs_vlan overridable: true overrides: parent: id: vlanObjectUUID type: VlanTag target: id: subDomainUUID name: Global \ Asia type: Domain type: VlanTag ? 'Example 2 : GET /fmc_config/v1/domain/childDomainUUID/object/vlantags/vlan_object_uuid?expanded=true&overrideTargetId=childDomainUUID ( Success: Test GET method from child domain on a VlanTagObject which has child domain assigned as override )' : value: data: endTag: 13 startTag: 13 type: VlanTagLiteral description: ' ' id: vlanObjectUUID links: self: /fmc_config/v1/domain/subDomainUUID/object/vlantags/vlanObjectUUID metadata: domain: id: subDomainUUID name: Global \ Asia lastUser: name: pvs name: pvs_vlan overridable: true overrides: parent: id: vlanObjectUUID type: VlanTag target: id: subDomainUUID name: Global \ Asia type: Domain type: VlanTag ? 'Example 3 : GET /fmc_config/v1/domain/childDomainUUID/object/vlans/vlan_object_uuid?expanded=true&overrideTargetId=deviceUUID ( Success: Test GET method from child domain on a VlanTagObject which has device assigned as override )' : value: data: endTag: 13 startTag: 13 type: VlanTagLiteral description: ' ' id: vlanObjectUUID links: self: /fmc_config/v1/domain/global/object/vlantags/vlanObjectUUID metadata: domain: id: subDomainUUID name: Global \ Asia lastUser: name: api name: pvs_vlan overridable: true overrides: parent: id: vlanObjectUUID type: VlanTag target: id: deviceUUID name: device_name type: Device type: VlanTag schema: $ref: '#/components/schemas/VlanTag' 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 VLAN tag associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateVlanTag parameters: - description: Unique identifier of the VLAN tag. 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/vlantags/vlan1_uuid ( PUT request to update an override on vlan tag object )' : value: data: endTag: 20 startTag: 10 type: VlanTagLiteral description: ' ' id: vlan1_uuid name: vlan1 overridable: true overrides: parent: id: vlan1_uuid type: VlanTag target: id: target_uuid name: 10.10.16.29 type: Device type: VlanTag schema: $ref: '#/components/schemas/VlanTag' type: object description: The input VLAN tag object model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/vlantags/vlan1_uuid ( PUT request to update an override on vlan tag object )' : value: data: endTag: 20 startTag: 10 type: VlanTagLiteral id: vlan1_uuid links: self: /api/fmc_config/v1/domain/domainUuid/object/vlantags/vlan1_uuid?overrideTargetId=target_uuid metadata: domain: id: domainUuid name: Global lastUser: name: admin timestamp: 0 name: vlan1 overridable: true overrides: parent: id: vlan1_uuid type: VlanTag target: id: target_uuid name: 10.10.16.29 type: Device type: VlanTag schema: $ref: '#/components/schemas/VlanTag' 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 components: schemas: TestAzureADRealm: description: Object that can be used to test Azure AD connection. properties: authSessionTimeout: description: Amount of time in minutes a user session is held onto without receiving another login event for sessions from ISE. The default value is 1440. format: int32 type: integer clientId: description: Application id of the client. type: string clientSecret: description: Application client secret for Azure AD realm. If a field contains '*********' (nine asterisks) on a PUT, will try to load the secret from the existing object. type: string consumerGroupId: description: An identifier of the corresponding Event Hubs consumer group. type: string description: description: Description of the Azure AD Realm. type: string enabled: description: Represents whether this Realm can be used by other policies. type: boolean eventHubsBroker: description: List of event hub broker with Kafka port 9093. type: string eventHubsConnString: description: Azure Event Hub SAP connection string. type: string eventHubsTopic: description: Azure Event Hub topic name. type: string excludedGroups: description: List of groups names to be excluded from downloads items: type: string type: array id: description: Connector ID from the CSDAC side, which is the base for a certain Azure AD realm. This value is optional. type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/AzureADMetadata' type: object name: description: Name of the Azure AD realm. type: string realmId: description: The sequence number of the creation of a certain realm. This value is optional. format: int32 type: integer tenantId: description: Tenant id of the Azure AD realm. type: string type: description: Value is 'AzureADRealm'. Read only fixed value. type: string uuid: description: Unique string associated with a certain Azure AD realm on the FMC side. This value is optional. type: string version: description: Revision, in `UUID` format, of the Azure AD Realm realm. type: string type: object LLFilesMap: additionalProperties: type: string type: object DNSServerGroupOverride: properties: description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object InternalCertificateGroup: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string objects: items: $ref: '#/components/schemas/IInternalCertificate' type: object type: array type: type: string version: type: string type: object Application: properties: appCategories: items: $ref: '#/components/schemas/IApplicationCategory' type: object type: array appId: format: int32 type: integer appProductivity: $ref: '#/components/schemas/ApplicationProductivity' type: object applicationTags: items: $ref: '#/components/schemas/IApplicationTag' type: object type: array applicationTypes: items: $ref: '#/components/schemas/IApplicationType' type: object type: array categories: items: $ref: '#/components/schemas/IApplicationCategory' type: object type: array decrypted: type: boolean deprecated: type: boolean description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object productivity: $ref: '#/components/schemas/IApplicationProductivity' type: object risk: $ref: '#/components/schemas/IApplicationRisk' type: object tags: items: $ref: '#/components/schemas/IApplicationTag' type: object type: array type: type: string version: type: string type: object GeoLocationObjectListContainer: properties: items: $ref: '#/components/schemas/GeoLocationObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object VlanTagListContainer: properties: items: $ref: '#/components/schemas/VlanTag' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ServiceAccessObject: properties: defaultAction: enum: - ALLOW - DENY type: string description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrideTargetId: type: string overrides: $ref: '#/components/schemas/IOverride' type: object rules: items: $ref: '#/components/schemas/IServiceAccessRule' type: object type: array type: type: string version: type: string required: - defaultAction type: object IRealmEntity: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object ValidateCertFile: description: Model for the upload of X.509 PEM or DER formatted certificate/key files. properties: cert: description: ' A Unicode string containing PEM formatted certificate string as per RFC 5280 extracted from the uploaded file.' type: string fileName: description: ' The name of the file to be uploaded. Certificate files are only accepted in PEM and DER format. Private key files are accepted in PEM and DER format (.key and .pem are the extension commonly used for PEM formatted files, .der is the extension commonly used for DER formatted files).' type: string fileType: enum: - CERT - KEY type: string filesMap: $ref: '#/components/schemas/LLFilesMap' type: object privateKey: description: ' A Unicode string PEM formatted private key as per RFC 5280 extracted from the uploaded file.' type: string type: description: ' A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. Fixed value of ''ValidateCertFile''' type: string type: object AzureADRealm: description: Realm configuration object can be used to connect to Azure AD. properties: authSessionTimeout: description: Field for the amount of time in minutes a user session is held onto without receiving another login event for sessions from ISE. The default value is 1440. format: int32 type: integer clientId: description: Field to specify the application id of the client. type: string clientSecret: description: Field to specify the application client secret for Azure AD realm. Must not be empty for POST. It will be shown as '*********' (nine asterisks). If a field contains '*********' (nine asterisks) on a PUT, we will try to load the secret from the existing object. type: string consumerGroupId: description: An identifier of the corresponding Event Hubs consumer group. type: string description: description: Description of the Azure AD Realm. type: string enabled: description: Field represents whether this Realm can be used by other policies. type: boolean eventHubsBroker: description: List of event hub broker with Kafka port 9093. type: string eventHubsConnString: description: Azure Event Hub SAP connection string. type: string eventHubsTopic: description: Azure Event Hub topic name. type: string excludedGroups: description: List of groups names to be excluded from downloads items: type: string type: array id: description: Connector ID from the CSDAC side, which is the base for a certain Azure AD realm. type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/AzureADMetadata' type: object name: description: Name of the Azure AD realm. type: string realmId: description: The sequence number of the creation of a certain realm. format: int32 type: integer tenantId: description: Field for the tenant id of the Azure AD realm. type: string type: description: Value is 'AzureADRealm'. Read only fixed value. type: string uuid: description: Unique string associated with a certain Azure AD realm on the FMC side. type: string version: description: Revision, in `UUID` format, of the Azure AD Realm realm. type: string type: object ExtendedCommunityListListContainer: properties: items: $ref: '#/components/schemas/ExtendedCommunityList' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object FQDNOverrideListContainer: properties: items: $ref: '#/components/schemas/FQDNOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DynamicObjectMappingsBulk: properties: add: items: $ref: '#/components/schemas/DynamicObjectWithMappingsBulk' type: object type: array description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string remove: items: $ref: '#/components/schemas/DynamicObjectWithMappingsBulk' type: object type: array type: type: string version: type: string type: object AnyConnectProfileModelListContainer: properties: items: $ref: '#/components/schemas/AnyConnectProfileModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IIntrusionRuleThreshold: description: Model representing intrusion rule threshold setting. properties: count: description: Number of seconds to match before generating an event. format: int32 type: integer description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string seconds: description: Time in seconds for which the rule is matched before generating an event. format: int32 type: integer thresholdType: description: 'Rate which must be exceeded by a source or destination host before a rule can generate an event. One of: LIMIT | THRESHOLD | BOTH' enum: - LIMIT - THRESHOLD - BOTH type: string trackBy: description: 'Value describing the attribute by which configuration generates the event. One of: SOURCE | DESTINATION' enum: - SOURCE - DESTINATION type: string type: type: string version: type: string type: object AnyConnectCustomAttributeModelListContainer: properties: items: $ref: '#/components/schemas/AnyConnectCustomAttributeModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object SIListMetadata: properties: domain: $ref: '#/components/schemas/Domain' type: object entryCount: format: int32 type: integer isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object listUpdateTime: format: int32 type: integer matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object timestamp: format: int32 type: integer validEntries: items: type: string type: array type: object MacAddressPool: properties: description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object macAddressRange: type: string metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrideTargetId: type: string overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string required: - macAddressRange type: object VariableSet: properties: description: type: string id: type: string isDefault: type: boolean links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string variables: items: $ref: '#/components/schemas/VariableSetVarDef' type: object type: array version: type: string type: object ApplicationProductivityListContainer: properties: items: $ref: '#/components/schemas/ApplicationProductivity' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IGroupPolicyAddressAssignmentModel: description: Model representiing the Address Assignment details that will be assigned to the endhost. properties: defaultDomainName: description: Optional. Specifies the name of the default domain type: string dhcpScope: $ref: '#/components/schemas/IReference' description: Optional. Represents DHCP Network for this group.Choose or create a Network Object containing the IPv4 address of the DHCP Network for this group. type: object ipv4LocalAddressPool: description: Optional. Represents IPv4 address assignment that is applied based on address pools that are specific to user-groups in Remote Access VPN items: $ref: '#/components/schemas/IReference' type: object type: array type: object NetworkObjectOverlaps: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string overlapType: enum: - PARTIAL - FULL type: string overlappingLiterals: items: $ref: '#/components/schemas/NetworkLiteralOverlaps' type: object type: array overlappingObjects: items: $ref: '#/components/schemas/NetworkObjectOverlaps' type: object type: array type: type: string type: object IIntrusionRuleSuppression: description: Model representing intrusion rule suppression setting. properties: description: type: string destinationNetworks: description: Object representing destination networks selected for the intrusion rule suppression setting. items: $ref: '#/components/schemas/INetworkAddress' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string sourceNetworks: description: Object representing source networks selected for the intrusion rule suppression setting. items: $ref: '#/components/schemas/INetworkAddress' type: object type: array type: type: string version: type: string type: object IFileWrapper: properties: attrib: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string path: type: string type: type: string type: object Snort3IntrusionRuleGroupsObject: description: Object representing details for Snort 3 intrusion rulegroup. properties: canonicalName: description: Fully Qualified name of Snort 3 intrusion rulegroup. type: string childGroups: description: List of IntrusionRuleGroups associated with the parent rulegroup. items: $ref: '#/components/schemas/ISnort3IntrusionRuleGroupsModel' type: object type: array defaultSecurityLevel: enum: - DISABLED - LEVEL_1 - LEVEL_2 - LEVEL_3 - LEVEL_4 - DEFAULT type: string description: description: Description of the Snort 3 intrusion rulegroup. type: string id: description: Unique identifier of the Snort 3 intrusion rulegroup. type: string isSystemDefined: description: Read-only field indicating if the rulegroup is system-defined (i.e., Talos provided). If value is false, then rule is user-defined. type: boolean links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Snort3IntrusionRuleGroupMetadata' description: Object representing metadata properties of Snort 3 intrusion rulegroup. type: object name: description: Name of the Snort 3 intrusion rulegroup. type: string overrideSecurityLevel: enum: - DISABLED - LEVEL_1 - LEVEL_2 - LEVEL_3 - LEVEL_4 - DEFAULT type: string parentGroup: $ref: '#/components/schemas/IReference' description: Object representing parent group of the current Snort 3 intrusion rulegroup. type: object totalRuleCount: description: Total rules count for the current Snort 3 intrusion rulegroup. format: int32 type: integer type: description: Type of the response object. This value is always IntrusionRuleGroup. type: string version: type: string type: object SinkholeListContainer: properties: items: $ref: '#/components/schemas/Sinkhole' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ICertificateParametersModel: properties: commonName: type: string countryCode: type: string customFqdn: type: string email: type: string includeDeviceIp: type: string includeDeviceSerial: type: boolean includeFQDN: enum: - DEVICE_HOSTNAME - NONE - CUSTOM - DEFAULT type: string locality: type: string organization: type: string organizationalUnit: type: string state: type: string type: object PortObjectOverlaps: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string overlapType: enum: - PARTIAL - FULL type: string overlappingLiterals: items: $ref: '#/components/schemas/PortLiteralOverlaps' type: object type: array overlappingObjects: items: $ref: '#/components/schemas/PortObjectOverlaps' type: object type: array protocol: type: string type: type: string type: object HostObjectListContainer: properties: items: $ref: '#/components/schemas/HostObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ErrorResponse: properties: category: description: Describes the category of the error thrown. enum: - FRAMEWORK - OTHER - VALIDATION type: string messages: description: List of error messages which the response has. items: $ref: '#/components/schemas/ErrorMessagesContainer' type: object type: array severity: description: Specifies the Highest level severity among all the error messages. enum: - ERROR - WARN type: string type: object ICMPV6ObjectOverrideListContainer: properties: items: $ref: '#/components/schemas/ICMPV6ObjectOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object AnyProtocolPortObjectListContainer: properties: items: $ref: '#/components/schemas/AnyProtocolPortObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IDHCPIPv6DNSServer: properties: importFromInternalServer: type: boolean ipAddresses: items: type: string type: array type: object IVpnEstContentModel: properties: enrollmentUrl: type: string fingerprint: type: string ignoreServerCertificateValidations: type: boolean password: type: string sourceInterface: $ref: '#/components/schemas/IReference' type: object username: type: string type: object IKEv1IPsecProposal: properties: description: type: string espEncryption: type: string espHash: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string type: type: string version: type: string type: object IRuleRecommendation: properties: acceptDisabledRules: type: boolean lastUpdatedTime: format: int32 type: integer networks: items: $ref: '#/components/schemas/Snort3IPSReferenceObject' type: object type: array recommendationInUse: type: boolean securityLevel: enum: - LEVEL_1 - LEVEL_2 - LEVEL_3 - LEVEL_4 type: string type: object ExternalCertificateListContainer: properties: items: $ref: '#/components/schemas/ExternalCertificate' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object AnyConnectExternalBrowserPackageModel: description: File object representing AnyConnect External Browser Package file. properties: description: description: User provided resource description. type: string fileName: description: Name of the External Browser Package file. type: string fileType: enum: - ANYCONNECT_VPN_PROFILE - ANYCONNECT_MANAGEMENT_VPN_PROFILE - AMP_ENABLER - FEEDBACK - ISE_POSTURE - NETWORK_ACCESS_MANAGER - NETWORK_VISIBILITY - UMBRELLA_ROAMING - WEB_SECURITY type: string files: items: $ref: '#/components/schemas/IFileWrapper' type: object type: array filesMap: $ref: '#/components/schemas/LLFilesMap' type: object id: description: Unique identifier representing this resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User provided resource name. type: string type: description: 'Type associated with resource: AnyConnectExternalBrowserPackage.' type: string version: type: string type: object AnyConnectPackageModelListContainer: properties: items: $ref: '#/components/schemas/AnyConnectPackageModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ObjectUsage: description: A model representing object usage response. properties: description: type: string id: description: Unique identifier of resource. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing related links. type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: description: User chosen resource name. type: string type: description: Type of resource. type: string version: type: string type: object IAnyConnectUserDefinedAttribute: properties: name: type: string value: type: string type: object ISecurityGroupTagLiteral: properties: name: type: string tag: format: int32 type: integer type: type: string type: object IUsersContainer: properties: objects: items: $ref: '#/components/schemas/IRealmEntity' type: object type: array type: object IRouteMapEntry: description: List of route maps entries already configured for this route map object. properties: action: description: 'Indicate the redistribution access: PERMIT or DENY' enum: - PERMIT - DENY type: string addToExistingCommunity: type: boolean asPathLists: description: Enable matching the BGP autonomous system path access list with the specified path access list. items: $ref: '#/components/schemas/IReference' type: object type: array asPathPrependASPath: description: Prepend an arbitrary autonomous system path string to BGP routes. items: format: int32 type: integer type: array asPathPrependLastASToASPath: description: Prepend the AS path with the last AS number. format: int32 type: integer automaticTagSetting: description: Automatically compute the tag value. type: boolean communityListSetting: description: Enable matching the BGP community with the specified community. format: int32 type: integer communityListSettingInternet: description: 'Internet: one of the well-known communities' type: boolean communityListSettingNoAdvertise: description: 'No Advertise: one of the well-known communities' type: boolean communityListSettingNoExport: description: 'No-Export: One of the well-known communities' type: boolean communityLists: description: Enable matching the BGP community with the specified community. items: $ref: '#/components/schemas/IReference' type: object type: array convertRouteTagIntoASPath: type: boolean extendedCommunityAdditive: type: boolean extendedCommunityLists: items: $ref: '#/components/schemas/IReference' type: object type: array extendedCommunityRouteTarget: type: string interfaceNames: description: Match traffic based on the (ingress/egress) interfaces. Logical names. items: type: string type: array interfaces: description: Match traffic based on the (ingress/egress) interfaces. Input security Zones. items: $ref: '#/components/schemas/IReference' type: object type: array ipv4AccessListAddresses: description: Match IPv4 (routes/traffic) based on the route address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv4AccessListNextHops: description: Match IPv4 (routes/traffic) based on the next-hop address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv4AccessListRouteSources: description: 'Match IPv4 (routes/traffic) based on the advertising source address of the route. ' items: $ref: '#/components/schemas/IReference' type: object type: array ipv4PrefixListAddresses: description: Match IPv4 (routes/traffic) based on the route address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv4PrefixListNexthops: description: Match IPv4 (routes/traffic) based on the next-hop address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv4PrefixListRouteSources: description: 'Match IPv4 (routes/traffic) based on the advertising source address of the route. ' items: $ref: '#/components/schemas/IReference' type: object type: array ipv6AccessListAddresses: description: Match IPv6 (routes/traffic) based on the route address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv6AccessListNextHops: description: Match IPv6 (routes/traffic) based on the next-hop address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv6AccessListRouteSources: description: Match IPv6 (routes/traffic) based on the advertising source address of route. items: $ref: '#/components/schemas/IReference' type: object type: array ipv6PrefixListAddresses: description: Match IPv6 (routes/traffic) based on the route address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv6PrefixListNexthops: description: Match IPv6 (routes/traffic) based on the next-hop address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv6PrefixListRouteSources: description: Match IPv6 (routes/traffic) based on the advertising source address of route. items: $ref: '#/components/schemas/IReference' type: object type: array localPreferenceSetting: description: Preference value for the autonomous system path format: int32 type: integer metricBandwidth: description: Metric value or bandwidth in Kbits per second format: int32 type: integer metricRouteValues: description: Enable matching the metric of a route items: format: int32 type: integer type: array metricType: description: 'Valid values are : internal, type-1, or type-2.' enum: - INTERNAL - TYPE_1 - TYPE_2 type: string nextHopIPV4Setting: description: Specify a next hop IPv4 address of the next hop to which packets are output. enum: - USE_PEER_ADDRESS - SPECIFIC_IP type: string nextHopIPV6Setting: description: Specify a next hop IPv6 address of the next hop to which packets are output. enum: - USE_PEER_ADDRESS - SPECIFIC_IP type: string originSetting: description: BGP origin code. Valid values are Local IGP Local IGP and Incomplete. enum: - LOCAL_IGP - INCOMPLETE type: string policyLists: description: Configure a route map to evaluate and process a BGP policy. items: $ref: '#/components/schemas/IReference' type: object type: array prefixListIPV4Setting: $ref: '#/components/schemas/IReference' description: Match IPv4 (routes/traffic) based on the route address. type: object prefixListIPV6Setting: $ref: '#/components/schemas/IReference' description: Match IPv6 (routes/traffic) based on the route address. type: object routeTypeExternal1: description: Enable External1 route type type: boolean routeTypeExternal2: description: Enable External2 route type type: boolean routeTypeInternal: type: boolean routeTypeLocal: description: Enable Local route type type: boolean routeTypeNSSAExternal1: description: Enable NSSA-External1 route type type: boolean routeTypeNSSAExternal2: description: Enable NSSA-External2 route type type: boolean sequence: description: Indicates the position a new route map entry will have in the list of route maps entries already configured for this route map object format: int32 type: integer specificCommunityNone: type: boolean specificIPsIPV4Setting: items: type: string type: array specificIPsIPV6Setting: items: type: string type: array tagValues: description: This setting allows you to match any routes that have a specified security group tag. items: format: int32 type: integer type: array weightSetting: description: BGP weight for the routing table format: int32 type: integer required: - action - sequence type: object ExtendedAccessListModel: description: An access control list (ACL) consists of one or more access control entries (ACE) that collectively define the network traffic profile. Extended Access Control List identifies traffic based on source and destination address and ports. Supports IPv4 and IPv6 addresses, which you can mix in a given rule. properties: description: description: User-provided object description. type: string entries: description: List of networks and ports entries that this object holds. items: $ref: '#/components/schemas/IExtendedACLEntry' type: object type: array id: description: Unique identifier (UUID) for the Extended Access Control List. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for Extended Access Control List. type: object name: description: The unique name for the Extended Access Control List object. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type of Extended Access Control List object. type: string version: description: Version number of the response object. type: string required: - entries type: object SIURLListListContainer: properties: items: $ref: '#/components/schemas/SIURLList' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object LocalRealmUserListContainer: properties: items: $ref: '#/components/schemas/LocalRealmUser' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object SIDNSList: description: Object representing a static list of DNS servers uploaded by the user properties: description: type: string fileName: type: string id: description: Unique identifier representing Security Intelligence DNS list. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/SIListMetadata' type: object name: description: Name of the Security Intelligence DNS List object. type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: description: Type must be SIDNSList. type: string version: description: Version number of the response object. type: string type: object PrivateResourceListContainer: properties: items: $ref: '#/components/schemas/PrivateResource' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IVlanTagLiteral: properties: endTag: format: int32 type: integer startTag: format: int32 type: integer type: type: string type: object IPortObject: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object AnyConnectPackageModel: description: File objects represent AnyConnect Client Image files. properties: description: description: User provided resource description. type: string fileName: description: Name of the AnyConnect client image. type: string fileType: enum: - ANYCONNECT_VPN_PROFILE - ANYCONNECT_MANAGEMENT_VPN_PROFILE - AMP_ENABLER - FEEDBACK - ISE_POSTURE - NETWORK_ACCESS_MANAGER - NETWORK_VISIBILITY - UMBRELLA_ROAMING - WEB_SECURITY type: string files: items: $ref: '#/components/schemas/IFileWrapper' type: object type: array filesMap: $ref: '#/components/schemas/LLFilesMap' type: object id: description: Unique identifier representing this resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User provided resource name. type: string type: description: 'Type associated with resource: AnyConnectPackage.' type: string version: type: string type: object PrivateResource: properties: certificate: $ref: '#/components/schemas/IReference' type: object description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string reachableAddresses: items: $ref: '#/components/schemas/INetworkObjectsContainer' type: object type: array resourceAddresses: items: $ref: '#/components/schemas/IHybridResourceAddressesContainer' type: object type: array ssePrivateResourceId: format: int32 type: integer targets: items: $ref: '#/components/schemas/IReference' type: object type: array type: type: string version: type: string type: object Ikev1PolicyObject: properties: authenticationMethod: type: string description: type: string diffieHellmanGroup: format: int32 type: integer encryption: type: string hash: type: string id: type: string lifetimeInSeconds: format: int32 type: integer links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string priority: format: int32 type: integer type: type: string version: type: string type: object LocalRealmUser: description: Defines Local Realm User properties: description: description: User provided resource description. type: string id: description: Unique identifier of Local Realm User type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of Local Realm Object. type: object name: description: Name for the user type: string password: description: Password for the user. type: string realm: $ref: '#/components/schemas/IReference' description: Realm Object under which the user has to be added. type: object type: description: 'Type associated with resource: LocalRealmUser.' type: string version: description: Version number of the response object. type: string type: object ResourceProfile: properties: description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string numOfCPUs: format: int32 type: integer overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object RealmTest: description: Object that can be used to test Realm connection. properties: identityConnector: $ref: '#/components/schemas/AzureADConnector' description: Contains information about the CSDAC connector used by Azure AD type: object type: description: Value is 'RealmTest'. Read only fixed value. type: string type: object AzureADConnector: properties: clientId: type: string clientSecret: type: string consumerGroupId: type: string eventHubsBroker: type: string eventHubsConnString: type: string eventHubsTopic: type: string excludedGroups: items: type: string type: array id: type: string includedGroups: items: type: string type: array tenantId: type: string type: type: string type: object ApplicationListContainer: properties: items: $ref: '#/components/schemas/Application' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object BFDTemplateListContainer: properties: items: $ref: '#/components/schemas/BFDTemplate' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ApplicationTag: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object ICertEnrollManualCaCertificateModel: description: A model representing definition of fields related to Manual Certificate Enrollment Object. properties: base64Content: description: represents CA Certificate in Base64 format. type: string caOnly: description: Optional. Represents whether the certfiicate enrollment object contains only CA Certificate and no Identity Certificate. Default is false. type: boolean type: object IApplicationCategory: description: Represents an ApplicationCategory. properties: description: description: Application category resource description. type: string id: description: Unique identifier for the application category. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the application category. type: object name: description: Name of the application category. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always ApplicationCategory. type: string version: description: Version number of the response object. type: string type: object ApplicationType: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object RadiusServerGroupModelListContainer: properties: items: $ref: '#/components/schemas/RadiusServerGroupModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object TimeRangeListContainer: properties: items: $ref: '#/components/schemas/TimeRange' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object SIDNSFeed: description: Object representing a user-specified third-party feed. properties: checksumURL: type: string description: type: string feedURL: type: string id: description: Unique identifier representing the Security Intelligence DNS feed. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/SIFeedMetadata' type: object name: description: Name of the Security Intelligence DNS Feed object. type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: description: Type must be SIDNSFeed. type: string updateFrequency: format: int32 type: integer version: description: Version number of the response object. type: string type: object IAsPathListEntry: properties: action: enum: - PERMIT - DENY type: string regularExpression: type: string sequence: format: int32 type: integer required: - sequence type: object IKEv2IPsecProposal: properties: description: type: string encryptionAlgorithms: items: type: string type: array id: type: string integrityAlgorithms: items: type: string type: array links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string type: type: string version: type: string type: object RadiusServerGroupModel: description: Radius Server Group objects contain one or more references to Radius servers. These servers are used to authenticate users logging in through Remote Access VPN connections. properties: description: description: User provided resource description. type: string dynamicAuthorizationPort: description: ASA will listen to the port for the CoA policy updates from ISE. Default is 1700, the range is 1024 to 65535. format: int32 type: integer enableAuthorizeOnly: description: ISE server is used only for authorization when certificate authentication is enabled type: boolean enableDynamicAuthorization: description: Enable the Radius Dynamic Authorization (ISE Change of Authorization, CoA) services for the AAA server group type: boolean enableInterimAccountUpdate: description: Enable the periodic generation of Radius interim-accounting-update messages type: boolean enableMergeDacl: description: Enable merge of downloadable ACL with the ACL received in the Cisco AV pair from a RADIUS Server. type: boolean groupAccountingMode: description: Indicates whether accounting messages are sent to a single server (single mode) or sent to all servers in the group (simultaneous mode) enum: - SINGLE - MULTIPLE type: string id: description: Unique identifier representing the CertificateMap object. type: string interimAccountUpdateInterval: description: Interval at which the accounting records are transmitted for every VPN session to the server group. Default 24 hours, Range 1-120 hours format: int32 type: integer links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object mergeDaclPlacementOrder: description: Specifies whether the downloadable ACL entries should be placed after the Cisco AV pair entries or before. enum: - MERGE_DACL_BEFORE_AV_PAIR_ACL - MERGE_DACL_AFTER_AV_PAIR_ACL type: string metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for the CertificateMap. type: object name: description: User provided resource name type: string radiusServers: items: $ref: '#/components/schemas/IRadiusServers' type: object type: array realm: $ref: '#/components/schemas/IReference' type: object retryInterval: description: Specifies the retry interval (1-10 seconds) for the request format: int32 type: integer type: description: 'Type associated with resource: RadiusServerGroup.' type: string version: type: string required: - radiusServers - retryInterval type: object ICountryModel: description: Represents a Country. properties: description: description: This field is deprecated and should not be used. type: string id: description: Identifier matching country from geolocation database. type: string iso2: description: ISO2 country code string. type: string iso3: description: ISO3 country code string. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the country. type: object name: description: Name of the Country. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always Country. type: string version: description: Version number of the response object. type: string type: object ICMPV6ObjectListContainer: properties: items: $ref: '#/components/schemas/ICMPV6Object' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ExternalCACertificate: description: Represents the CA public key certificate object belonging to a trusted CA. properties: cert: description: PEM, DER, or PKCS#7 formatted certificate contents. type: string certFingerprint: description: Unique sequence used to identify the certificate. type: string crlSerials: description: Serial numbers in hex format of certificates in the certificate revocation list. items: type: string type: array description: type: string id: description: Unique identifier representing resource. type: string issuerCommonName: description: Common name of the issuer that signed and issued the certificate. type: string issuerOrganization: description: Organization, company name, of the issuer that signed and issued the certificate. type: string issuerOrganizationUnit: description: Organization Unit, division or unit, of the issuer that signed and issued the certificate. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: description: User chosen resource name. type: string publicKeyFingerprint: description: SHA1 hash sequence used to identify the public key. type: string serialNumber: description: Unique number assigned by CA to the certificate on generation. The issuer name and serial number identify a unique certificate. type: string subjectCommonName: description: Common name of the subject being certified in the given certificate. type: string subjectOrganization: description: Organization, company name, of the subject being certified in the given certificate. type: string subjectOrganizationUnit: description: The Organization Unit, division or unit, of the subject being certified in the given certificate. type: string type: description: Type of the response object. This value is always 'InternalCertificate'. type: string validityEndDate: description: Certificate validity end date in ISO 8601 format. type: string validityStartDate: description: Certificate validity start date in ISO 8601 format. type: string version: type: string type: object SINetworkFeed: description: Object representing a user-specified third-party feed. properties: checksumURL: description: Checksum of the feed file on remote server. type: string description: description: Description of the Security Intelligence list. type: string feedURL: description: URL representing the Security Intelligence feed location. type: string id: description: Unique identifier representing the Security Intelligence Network feed. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object listType: format: int32 type: integer metadata: $ref: '#/components/schemas/SIFeedMetadata' description: Object representing metadata attributes for the SINetworkFeed object. type: object name: description: Name of the Security Intelligence Network Feed object. type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: description: Type must be SINetworkFeed. type: string updateFrequency: description: Feed update interval in minutes. format: int32 type: integer version: description: Version number of the response object. type: string type: object ISESecurityGroupTag: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object tag: format: int32 type: integer type: type: string version: type: string type: object IExternalCACertificate: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object NTPServerObjectListContainer: properties: items: $ref: '#/components/schemas/NTPServerObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IPv4PrefixListListContainer: properties: items: $ref: '#/components/schemas/IPv4PrefixList' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ICMPV6Object: description: An object defining a ICMPv6 Port object definition. properties: code: description: ICMP code number. format: int32 type: integer description: description: User provided resource description. type: string icmpType: description: ICMP type number. type: string id: description: Unique identifier. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object metadata: $ref: '#/components/schemas/PortMetadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: 'Type associated with resource: ICMPV6Object.' type: string version: description: Version number of the response object. type: string type: object INameServer: properties: name-server: type: string type: object OverlapWarning: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string networks: $ref: '#/components/schemas/NetworkOverlapsContainer' type: object ports: $ref: '#/components/schemas/PortOverlapsContainer' type: object type: type: string version: type: string type: object IPv4AddressPool: description: A model representing Ipv4AddressPool Object definition. properties: addressType: enum: - RANGE - SUPERNET type: string description: description: User provided resource description. type: string id: description: Unique identifier of response object. type: string ipAddressRange: description: 'Range of addresses available in the pool. Use dotted decimal notation and a dash between the beginning and the end address. Format: ipaddr-ipaddr e.g., 10.72.1.1-10.72.1.150.' type: string links: $ref: '#/components/schemas/Links' type: object mask: description: Specifies a subnet mask for the pool of addresses in X.X.X.X format. type: string metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string numberOfAddresses: format: int32 type: integer overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: type: string overrides: $ref: '#/components/schemas/IOverride' type: object rangeStart: format: int32 type: integer subnetPrefix: format: int32 type: integer supernetAddress: type: string supernetPrefix: format: int32 type: integer type: description: 'Type associated with resource: Ipv4AddressPool.' type: string version: description: Version number of the response object. type: string required: - ipAddressRange type: object CountryObjectListContainer: properties: items: $ref: '#/components/schemas/CountryObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object CertificateMapModelListContainer: properties: items: $ref: '#/components/schemas/CertificateMapModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IPKIServerKeyModel: properties: ignoreIpsecKeyusage: type: boolean keyName: type: string keySize: enum: - CertKey_512 - CertKey_768 - CertKey_1024 - CertKey_2048 - CertKey_3072 - CertKey_4096 - CertKey_256 - CertKey_384 - CertKey_521 type: string keyType: enum: - RSA - ECDSA - EdDSA type: string type: object IApplicationFilter: description: Represents an ApplicationFilter containing various Conditions and Applications. properties: appConditions: description: List of objects representing application conditions. items: $ref: '#/components/schemas/IAppCondition' type: object type: array applications: description: List of objects representing applications. items: $ref: '#/components/schemas/IApplicationModel' type: object type: array description: description: This field is deprecated and should not be used. type: string id: description: Unique identifier (UUID) for the application filter. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the application filter. type: object name: description: User-specified name of the application filter. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always ApplicationFilter. type: string version: description: Version number of the response object. type: string type: object IInterfaceGroupObjectModel: properties: description: type: string devices: items: $ref: '#/components/schemas/IInterfaceDeviceModel' type: object type: array id: type: string interfaceMode: enum: - PASSIVE - INLINE - SWITCHED - ROUTED - MANAGEMENT - LOOPBACK type: string interfaces: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object IGroupPolicySessionSettingsModel: description: Model representing the Configurations for AnyConnect Client Sessions. properties: accessHours: $ref: '#/components/schemas/IReference' description: Optional. Specifies the range of time this group policy is available to be applied to a remote access user type: object maxConnectionTimeAlertInterval: description: Optional. Specifies the time at which a session timeout alert message is displayed to the user. The default alert interval is one minute. The range is from 1 - 30 minutes. format: int32 type: integer maxConnectionTimeout: description: Optional. Specifies a maximum amount of time for VPN connections. Range is 1-35791394 minutes. The default value for this attribute is null and its behaviour is unlimited time allowed per connection. format: int32 type: integer simultaneousLoginPerUser: description: Optional. Specifies the number of simultaneous logins allowed for any user. The default value is 3. The range is 0-2147483647 format: int32 type: integer vpnIdleTimeout: description: Optional. Specifies a VPN idle timeout period. If there is no communication activity on the connection in this period, the ASA terminates the connection. The minimum time is 1 minute, the maximum time is 35791394 minutes, and the default is 30 minutes. format: int32 type: integer vpnIdleTimeoutAlertInterval: description: Optional. Specifies the time at which an idle timeout alert message is displayed to the user. This alert message tells users how many minutes they have left until their VPN session will be disconnected due to inactivity. The default alert interval is one minute. The range is from 1 - 30 minutes. format: int32 type: integer type: object IVlanModel: properties: data: $ref: '#/components/schemas/IVlanTagLiteral' type: object description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object CustomSIURLList: description: Object representing a static list of URL addresses uploaded by the user properties: description: type: string fileName: description: Name of the custom Security Intelligence URL List file as specified by user. type: string files: items: $ref: '#/components/schemas/IFileWrapper' type: object type: array filesMap: $ref: '#/components/schemas/LLFilesMap' type: object id: description: Unique identifier of custom Security Intelligence URL List object. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/CustomSIListMetadata' description: Object representing metadata attributes for the CustomSIURLList object. type: object name: description: Name of the custom Security Intelligence URL List object. type: string type: description: Must be CustomSIURLListObject type: string validateOnly: description: Validate the uploaded list file only. By default is set to false. type: boolean version: description: Version number of the response object. type: string type: object Snort3IPSRulesObject: description: Object representing a Snort 3 intrusion rule. properties: defaultState: description: 'Default State of the rule. One of: DROP | BLOCK | ALERT | DISABLE | DEFAULT' enum: - DROP - BLOCK - ALERT - DISABLE - DEFAULT - PASS - REJECT - REACT - REWRITE type: string description: description: User provided resource description. type: string gid: description: Generator Identifier used to identify the part of Snort which generates an event. format: int32 type: integer id: description: Unique identifier (UUID) for the intrusion rule. type: string isSystemDefined: description: Read-only field indicating if the rule is system-defined (i.e., Talos provided). If value is false, then rule is user-defined. type: boolean links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Snort3IPSRuleMetadata' description: Object representing metadata attributes for the intrusion rule. type: object msg: description: User provided rule description. type: string name: description: Name of the intrusion rule. type: string overrideState: description: 'Override State indicates the rule action has been changed from the default action to a different action. One of: DROP | BLOCK | ALERT | REWRITE | REJECT | PASS | DISABLE | DEFAULT' enum: - DROP - BLOCK - ALERT - DISABLE - DEFAULT - PASS - REJECT - REACT - REWRITE type: string recommendedState: enum: - DROP - BLOCK - ALERT - DISABLE - DEFAULT - PASS - REJECT - REACT - REWRITE type: string revision: format: int32 type: integer ruleAction: description: Object containing list of rule actions specified for all intrusion policies. items: $ref: '#/components/schemas/IRuleAction' type: object type: array ruleData: description: Details of the rule based on which rule created or updated. type: string ruleGroups: description: Object containing a list of rules groups associated with the rule. items: $ref: '#/components/schemas/IReference' type: object type: array sid: description: Snort Identifier used to uniquely identify Snort rules. format: int32 type: integer suppression: $ref: '#/components/schemas/IIntrusionRuleSuppression' description: Object containing configuration which allows users to suppress events for a rule for specific trusted IP addresses. type: object threshold: $ref: '#/components/schemas/IIntrusionRuleThreshold' description: Object containing threshold configuration for the rule. type: object type: description: Type of the response object. This value is always IntrusionRule. type: string version: type: string type: object Snort3IntrusionRuleGroupsObjectListContainer: properties: items: $ref: '#/components/schemas/Snort3IntrusionRuleGroupsObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DistinguishedNameListContainer: properties: items: $ref: '#/components/schemas/DistinguishedName' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object URLGroupObjectListContainer: properties: items: $ref: '#/components/schemas/URLGroupObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IAuthTypeAndString: properties: cryptoEncryptionType: enum: - PLAINTEXT type: string cryptoKeyString: type: string type: object AzureADMetadata: properties: domain: $ref: '#/components/schemas/Domain' type: object isDownloading: type: boolean isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object timestamp: format: int32 type: integer type: object AzureADStatusListContainer: properties: items: $ref: '#/components/schemas/AzureADStatus' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object Snort3IPSRulesFileUpload: description: An object that represents the details for Snort3 custom rule import. properties: files: items: $ref: '#/components/schemas/IFileWrapper' type: object type: array ruleComment: type: string ruleGroups: $ref: '#/components/schemas/Object' description: Indicates the comma separated List of rule groups to which rules should be associated. type: object ruleImportMode: description: Indicates the rule Import mode. Can be either MERGE or REPLACE. enum: - MERGE - REPLACE type: string summary: $ref: '#/components/schemas/RuleImportSummary' description: Object representing details of Deleted,Added,Unassociated,Updated,Skipped rules. type: object validateOnly: description: Specifies if rules should be validated or validated and imported. Default value is true. type: boolean type: object StandardACLListContainer: properties: items: $ref: '#/components/schemas/StandardACL' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object PortObjectGroupOverrideListContainer: properties: items: $ref: '#/components/schemas/PortObjectGroupOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IOverride: description: Defines the override details for this object. properties: parent: $ref: '#/components/schemas/IReference' description: Link to the parent/global resource which is overriden. type: object target: $ref: '#/components/schemas/IReference' description: The device or the domain target on which this override is enabled. type: object type: object IAppCondition: description: Represents an AppCondition containing Application Types, Tags, Productivities, Risks, and Categories. properties: applicationTypes: description: List of objects representing application types. items: $ref: '#/components/schemas/IApplicationType' type: object type: array categories: description: List of objects representing application categories. items: $ref: '#/components/schemas/IApplicationCategory' type: object type: array filter: description: User-specified filter string. type: string productivities: description: List of objects representing application productivities. items: $ref: '#/components/schemas/IApplicationProductivity' type: object type: array risks: description: List of objects representing application risks. items: $ref: '#/components/schemas/IApplicationRisk' type: object type: array search: description: String representation of the application condition. type: string tags: description: List of objects representing application tags. items: $ref: '#/components/schemas/IApplicationTag' type: object type: array type: description: Type of the response object. This value is always ApplicationFilterCondition. type: string type: object INetworkAddress: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object UrlGroupOverrideListContainer: properties: items: $ref: '#/components/schemas/UrlGroupOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object PortLiteralOverlaps: properties: overlapType: enum: - PARTIAL - FULL type: string overlappingLiterals: items: $ref: '#/components/schemas/PortLiteralOverlaps' type: object type: array overlappingObjects: items: $ref: '#/components/schemas/PortObjectOverlaps' type: object type: array port: type: string protocol: type: string type: type: string type: object ProtocolPortObjectOverrideListContainer: properties: items: $ref: '#/components/schemas/ProtocolPortObjectOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object VariableListContainer: properties: items: $ref: '#/components/schemas/Variable' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object URLCategory: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object TimeZoneObjectListContainer: properties: items: $ref: '#/components/schemas/TimeZoneObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object SIDNSListListContainer: properties: items: $ref: '#/components/schemas/SIDNSList' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DNSServerGroupObject: properties: defaultdomain: type: string description: type: string dnsservers: items: $ref: '#/components/schemas/INameServer' type: object type: array id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrideTargetId: type: string overrides: $ref: '#/components/schemas/IOverride' type: object retries: format: int32 type: integer timeout: format: int32 type: integer type: type: string version: type: string type: object IGroupPolicySSLSettingsModel: description: Model representing the Configuration of SSL parameters to be used when connecting to the Client. properties: dtlsCompression: description: Specifies DTLS Compression method (DISABLED,LZS). Default is DISABLED enum: - DISABLED - LZS type: string ignoreDFBit: description: Optional. Specifies to ignore the Don't Fragment (DF) bit in packets that need fragmentation.Allows the forced fragmentation of packets that have the DF bit set, allowing them to pass through the tunnel. Default is False type: boolean mtuSize: description: Optional. Specifies the maximum transmission unit (MTU) size for SSL VPN connections established by the Cisco AnyConnect VPN Client.Default is 1406 Bytes, valid range is 576 to 1462 Bytes. format: int32 type: integer sslCompression: description: Specifies SSL Compression method (DEFLATE,DISABLED,LZS). Default is DISABLED enum: - DISABLED - DEFLATE - LZS type: string type: object ProtocolPortObjectOverride: description: A model representing protocol port object override definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Always returns false for overrides. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object NetworkAddressOverridesListContainer: properties: items: $ref: '#/components/schemas/NetworkAddressOverrides' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ObjectUsageListContainer: properties: items: $ref: '#/components/schemas/ObjectUsage' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object NetworkOverrideListContainer: properties: items: $ref: '#/components/schemas/NetworkOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IPv6AddressPoolListContainer: properties: items: $ref: '#/components/schemas/IPv6AddressPool' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IPrivateResourceModel: properties: certificate: $ref: '#/components/schemas/IReference' type: object description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string reachableAddresses: items: $ref: '#/components/schemas/INetworkObjectsContainer' type: object type: array resourceAddresses: items: $ref: '#/components/schemas/IHybridResourceAddressesContainer' type: object type: array ssePrivateResourceId: format: int32 type: integer targets: items: $ref: '#/components/schemas/IReference' type: object type: array type: type: string version: type: string type: object ApplicationCategoryListContainer: properties: items: $ref: '#/components/schemas/ApplicationCategory' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ExternalCertificate: description: Represents a server public key certificate that does not belong to the user's organization. properties: cert: description: PEM, DER, or PKCS#7 formatted certificate contents. type: string certFingerprint: description: Unique sequence used to identify the certificate. type: string description: type: string id: description: Unique identifier representing resource. type: string issuerCommonName: description: Common name of the issuer that signed and issued the certificate. type: string issuerOrganization: description: Organization, company name, of the issuer that signed and issued the certificate. type: string issuerOrganizationUnit: description: Organization Unit, division or unit, of the issuer that signed and issued the certificate. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: description: User chosen resource name. type: string publicKeyFingerprint: description: SHA1 hash sequence used to identify the public key. type: string serialNumber: description: Unique number assigned by CA to the certificate on generation. The issuer name and serial number identify a unique certificate. type: string subjectCommonName: description: Common name of the subject being certified in the given certificate. type: string subjectOrganization: description: Organization, company name, of the subject being certified in the given certificate. type: string subjectOrganizationUnit: description: The Organization Unit, division or unit, of the subject being certified in the given certificate. type: string type: description: Type of the response object. This value is always 'ExternalCertificate'. type: string validityEndDate: description: Certificate validity end date in ISO 8601 format. type: string validityStartDate: description: Certificate validity start date in ISO 8601 format. type: string version: type: string type: object ApplicationFilter: description: Represents an ApplicationFilter containing various Conditions and Applications. properties: appConditions: description: List of objects representing application conditions. items: $ref: '#/components/schemas/IAppCondition' type: object type: array applications: description: List of objects representing applications. items: $ref: '#/components/schemas/IApplicationModel' type: object type: array description: description: This field is deprecated and should not be used. type: string id: description: Unique identifier (UUID) for the application filter. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the application filter. type: object name: description: User-specified name of the application filter. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always ApplicationFilter. type: string version: description: Version number of the response object. type: string type: object ISnort3PolicyRuleCount: properties: alert: format: int32 type: integer block: format: int32 type: integer disabled: format: int32 type: integer drop: format: int32 type: integer overridden: format: int32 type: integer pass: format: int32 type: integer reject: format: int32 type: integer rewrite: format: int32 type: integer type: object IPv4AddressPoolOverride: description: A model representing IPv4AddressPoolOverride definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Always returns false of overrides. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object URLObject: description: A model representing url object definition. properties: description: type: string id: description: Unique identifier of response object. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: 'Type associated with resource: URL.' type: string url: description: Actual URL of object. type: string version: description: Version number of the response object. type: string type: object URLGroupObject: description: A model representing URL group definition. properties: description: description: User provided resource description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object literals: description: Represents target URL associated with URL object. items: $ref: '#/components/schemas/IUrlLiteral' type: object type: array metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User assigned resource name. type: string objects: description: Represents URL objects in group. items: $ref: '#/components/schemas/IUrlModel' type: object type: array overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object LightAzureADRealm: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object DHCPIPv6PoolListContainer: properties: items: $ref: '#/components/schemas/DHCPIPv6Pool' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object PortObjectGroupListContainer: properties: items: $ref: '#/components/schemas/PortObjectGroup' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object SIDNSFeedListContainer: properties: items: $ref: '#/components/schemas/SIDNSFeed' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ServiceAccessObjectOverride: properties: description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object Domain: description: The details about the domain. properties: id: description: Unique UUID of this domain type: string links: $ref: '#/components/schemas/ILinks' description: Links to the domain resource URLs. type: object name: description: Name of the domain. type: string type: description: Domain type definition (fixed). type: string uuid: type: string type: object ExtendedCommunityListOverride: properties: description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object InternalCertificateGroupListContainer: properties: items: $ref: '#/components/schemas/InternalCertificateGroup' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object PortMetadata: properties: domain: $ref: '#/components/schemas/Domain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array parentType: type: string protocols: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object timestamp: format: int32 type: integer type: object RuleImportSummaryEntry: description: An object that represents rule import summary details. properties: count: description: Specifies the count of added,udpated,deleted,skipped,unassociated rules.By default shows 0 format: int32 type: integer rules: description: Specifies the rule details in the format GID:SID for the imported rules. items: type: string type: array type: description: Type of the response object. This value is always ruleimportsummaryentry. type: string type: object ConnectorStatusBody: properties: message: type: string status: type: string type: object MetadataUser: description: This object defines details about the user. properties: id: description: The unique UUID of the user type: string links: $ref: '#/components/schemas/ILinks' description: Contains the self referencing links to this resource type: object name: description: Name of the user. type: string type: description: The user type (fixed). type: string type: object NetworkGroupOverride: description: A model representing Network group override definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Always returns false of overrides. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object ApplicationCategory: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object RealmStatusListContainer: properties: items: $ref: '#/components/schemas/RealmStatus' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object TunnelTags: description: A model representing tunnel tag definition. properties: description: description: User provided description for tunnel tag object. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of tunnel tag object. type: object name: description: User-specified name of tunnel tag. type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: description: Type must be TunnelTag. type: string version: description: Version number of the response object. type: string type: object ExternalCACertificateGroup: description: Represents a group of trusted CA objects. properties: description: type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: description: User chosen resource name. type: string objects: items: $ref: '#/components/schemas/IExternalCACertificateBase' type: object type: array type: description: Type of the response object. This value is always 'ExternalCACertificateGroup'. type: string version: type: string type: object ExternalCertificateGroup: description: Represents a group of external certificate objects. properties: description: type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: description: User chosen resource name. type: string objects: items: $ref: '#/components/schemas/IExternalCertificate' type: object type: array type: description: Type of the response object. This value is always 'ExternalCertificateGroup'. type: string version: type: string type: object VlanTagGroupOverrideListContainer: properties: items: $ref: '#/components/schemas/VlanTagGroupOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IPv4AddressPoolOverrideListContainer: properties: items: $ref: '#/components/schemas/IPv4AddressPoolOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IPKIValidationUsageModel: properties: ipsecClient: type: boolean sslClient: type: boolean sslServer: type: boolean type: object ICMPV6ObjectOverride: properties: description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object ISnort3IntrusionRuleGroupsModel: properties: canonicalName: type: string childGroups: items: $ref: '#/components/schemas/ISnort3IntrusionRuleGroupsModel' type: object type: array defaultSecurityLevel: enum: - DISABLED - LEVEL_1 - LEVEL_2 - LEVEL_3 - LEVEL_4 - DEFAULT type: string description: type: string id: type: string isSystemDefined: type: boolean links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overrideSecurityLevel: enum: - DISABLED - LEVEL_1 - LEVEL_2 - LEVEL_3 - LEVEL_4 - DEFAULT type: string parentGroup: $ref: '#/components/schemas/IReference' type: object totalRuleCount: format: int32 type: integer type: type: string version: type: string type: object IMetadata: properties: domain: $ref: '#/components/schemas/IDomain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/IMetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/IReadonly' type: object timestamp: format: int32 type: integer type: object IApplicationRisk: description: Represents an ApplicationRisk. properties: description: description: Application risk resource description. type: string id: description: Unique identifier for the application risk. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the application risk. type: object name: description: Name of the application risk. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always ApplicationRisk. type: string version: description: Version number of the response object. type: string type: object ICertificateMapRules: description: Specify the contents of the certificate to evaluate. properties: component: description: Component of the client certificate to use for the matching rule. enum: - WHOLE_FIELD - COUNTRY - COMMON_NAME - DN_QUALIFIER - EMAIL_ADDRESS - GENERATIONAL_QUALIFIER - GIVEN_NAME - INITIALS - LOCALITY - NAME - ORGANISATION - ORGANISATIONAL_UNIT - SERIAL_NUMBER - SURNAME - STATE_PROVINCE - TITLE - USER_ID - UNSTRUCTURED_NAME - IP_ADDRESS - DOMAIN_COMPONENT type: string field: description: Field for the matching rule according to the Subject or the Issuer of the client certificate. enum: - SUBJECT - ALTERNATIVE_SUBJECT - ISSUER - EXTENDED_KEY_USAGE type: string operator: description: Operator for the matching rule as Equals, Contains, Does Not Equal or Does Not Contain. enum: - EQUALS - CONTAINS - DOES_NOT_EQUAL - DOES_NOT_CONTAIN type: string value: description: The value of the matching rule. The value is associated with the selected component and operator. type: string required: - component - field - operator - value type: object GlobalTimeZoneListContainer: properties: items: $ref: '#/components/schemas/GlobalTimeZone' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object CipherSuiteList: description: Represents a list of cipher suites. properties: description: type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object literals: description: The list of predefined cipher suites which are part of the cipher suite list object. items: $ref: '#/components/schemas/ICipherSuiteLiteral' type: object type: array metadata: $ref: '#/components/schemas/Metadata' type: object name: description: User chosen resource name. type: string type: description: Type of the response object. This value is always 'CipherSuiteList'. type: string version: type: string type: object DynamicObjectListContainer: properties: items: $ref: '#/components/schemas/DynamicObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object FileTypeModel: description: Object representing a FileType object within a FileCategory. properties: description: description: Description of the file type. type: string id: description: Unique identifier representing the FileType. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the FileType object. type: object name: description: Name of the FileType object. type: string type: description: Type must be FileType. type: string version: description: Version number of the response object. type: string type: object HostOverride: description: A model representing Host network override definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Always return false for overrides. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object KeyChainObjectListContainer: properties: items: $ref: '#/components/schemas/KeyChainObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object NetworkAddressListContainer: properties: items: $ref: '#/components/schemas/NetworkAddress' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DNSServerGroupOverrideListContainer: properties: items: $ref: '#/components/schemas/DNSServerGroupOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object EndPointDeviceTypeListContainer: properties: items: $ref: '#/components/schemas/EndPointDeviceType' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object Snort3IPSReferenceObject: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string value: type: string type: object NTPServerObject: properties: authKey: format: int32 type: integer authValue: type: string description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string value: type: string version: type: string type: object HostScanPackageObjectListContainer: properties: items: $ref: '#/components/schemas/HostScanPackageObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ISecurityGroupTag: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object tag: format: int32 type: integer type: type: string version: type: string type: object FileCategoryModelListContainer: properties: items: $ref: '#/components/schemas/FileCategoryModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object CustomSIURLListDownload: description: Object representing a CustomSIURLListDownload object. properties: attrib: description: Name of the downloaded file. type: string description: description: Description of the CustomSIURLListDownload object. type: string id: description: Unique identifier representing the CustomSIURLListDownload. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object name: description: Name of the CustomSIURLListDownload object. type: string path: description: Path of the file to download on the server. type: string type: description: Type must be CustomSIURLListDownload. type: string version: description: Version number of the response object. type: string type: object SSOServerOverrideListContainer: properties: items: $ref: '#/components/schemas/SSOServerOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IApplicationType: description: Represents an ApplicationType. properties: description: description: Application type resource description. type: string id: description: Unique identifier for the application type. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the application type. type: object name: description: Name of the application type. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always ApplicationType. type: string version: description: Version number of the response object. type: string type: object InterfaceGroupObject: properties: description: type: string devices: items: $ref: '#/components/schemas/IInterfaceDeviceModel' type: object type: array id: type: string interfaceGroup: format: int32 type: integer interfaceMode: enum: - PASSIVE - INLINE - SWITCHED - ROUTED - MANAGEMENT - LOOPBACK type: string interfaces: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object CustomSIIPListListContainer: properties: items: $ref: '#/components/schemas/CustomSIIPList' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IPv6AddressPool: description: A model representing Ipv6AddressPool Object definition. properties: description: description: User provided resource description. type: string id: description: Unique identifier of response object. type: string ipv6StartAddress: description: 'Specifies the number of IPv6 addresses to use in the pool starting at ipv6StartAddress, Format: ipv6_address/prefix_length.' type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string numberOfAddresses: description: IPv6 address available in the configured pool and the prefix length in bits. format: int32 type: integer overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: type: string overrides: $ref: '#/components/schemas/IOverride' type: object type: description: 'Type associated with resource: IPv6AddressPool.' type: string version: description: Version number of the response object. type: string required: - ipv6StartAddress - numberOfAddresses type: object IKEv1IPsecProposalListContainer: properties: items: $ref: '#/components/schemas/IKEv1IPsecProposal' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IPv6AddressPoolOverrideListContainer: properties: items: $ref: '#/components/schemas/IPv6AddressPoolOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object VpnCertEnrollmentModelListContainer: properties: items: $ref: '#/components/schemas/VpnCertEnrollmentModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IAnyConnectDynamicSplitTunnelAttribute: properties: excludeDomains: items: type: string type: array includeDomains: items: type: string type: array type: object ExtendedCommunityList: description: To have extended community filtering and community manipulation for Border Gateway Protocol (BGP) - import/export routes properties: entries: description: List of standard or expanded extended community entries that this object holds items: $ref: '#/components/schemas/IExtendedCommunityApiEntry' type: object type: array id: description: The unique UUID of this object. type: string links: $ref: '#/components/schemas/Links' description: Contains the full URL to the current object and its parent (if any) type: object metadata: $ref: '#/components/schemas/Metadata' description: Defines read only details about the object - whether it is system defined, last user who modified the object etc. type: object name: description: ' The unique name for the object.' type: string overridable: type: boolean overrideTargetId: type: string overrides: $ref: '#/components/schemas/IOverride' description: This is populated only if this object is an override and contains the parent (global) object id and whether this is an override on device or domain. type: object subType: description: Standard|Expanded type: string type: description: The unique type of this object,ExtendedCommunityList (fixed). type: string version: description: The unique object version (if any). type: string type: object Sinkhole: description: Description of Sinkhole. properties: action: description: User-specified action of the Sinkhole. enum: - MONITOR - BLOCK type: string description: type: string id: description: Unique identifier (UUID) representing the Sinkhole. type: string ipv4: description: User-specified ipv4 of the Sinkhole. type: string ipv6: description: User-specified ipv6 of the Sinkhole. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for the Sinkhole. type: object name: description: User-specified name of the Sinkhole. type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object sinkholeType: enum: - SINKHOLE_CN_C - SINKHOLE_MALWARE - SINKHOLE_PHISHING - NONE type: string type: description: Type of the object; this value is always Sinkhole. type: string version: type: string type: object UmbrellaProtectionPolicy: description: The details about the Umbrella Protection Policy from umbrella cloud properties: id: type: string lastFetchTimeStamp: description: Represents the timestamp of Umbella Protection policy names fetched from umbrella cloud type: string protectionPolicyNames: description: Represents protection policy names fetched from the umbrella cloud items: type: string type: array type: description: Value is 'UmbrellaProtectionPolicy'. Read only fixed value. type: string type: object IInterfaceDeviceModel: properties: description: type: string id: type: string interfaces: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object IGroupPolicyConnectionSettingsModel: description: Model representing the Configuration of Connection Settings for a Group Policy. properties: bypassUnsupportProtocol: description: Optional. Enables to determine whether to drop network traffic for which the FTD did not assign an IP address,or allow that traffic to bypass the FTD and be sent from the client unencrypted or in the clear. Default is False type: boolean clientDPDInterval: description: Optional. Specifies the DDPD interval from 5 to 3600 seconds, with which the client performs DPD. Default is 30 sec format: int32 type: integer clientFirewallPrivateNetworkRules: $ref: '#/components/schemas/IReference' description: Optional. If the split tunnel is configured the private network rule is the rule applied to the VPN virtual adapter interface on the client type: object clientFirewallPublicNetworkRules: $ref: '#/components/schemas/IReference' description: Optional. If the split tunnel is configured, the public network rule is the rule applied to other non-vpn interfaces on the client. type: object enableClientDPD: description: Optional. Enables client to quickly detect a condition where the peer is not responding, and the connection has failed. type: boolean enableGatewayDPD: description: Optional. Enables that the security appliance (gateway) can quickly detect a condition where the peer is not responding, and the connection has failed. type: boolean enableKeepAliveMessages: description: Optional. Enables connection through a proxy, firewall, or NAT device remains open. Default is True type: boolean enableSSLRekey: type: boolean gatewayDPDInterval: description: Optional. When enableGatewayDPD is enabled, interval is specified from 5 to 3600 seconds, with which the security appliance performs gateway dead peer detection.Default is 30 secs format: int32 type: integer keepAliveMessageInterval: description: Optional.Specifies the interval for Keep-Alive messsage. Default is 20 seconds. Valid range is from 15 - 600 seconds. format: int32 type: integer rekeyInterval: description: Optional. Specifies the number of minutes from the start of the session until the re-key takes place. Range is 4-10080. Default is 4 minutes format: int32 type: integer rekeyMethod: description: Optional. If SSL rekey is enabled, specifies if new tunnel has to be established or existing one has to be renegotiated. Default is NEW_TUNNEL enum: - NEW_TUNNEL - EXISTING_TUNNEL type: string type: object TunnelTagsListContainer: properties: items: $ref: '#/components/schemas/TunnelTags' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object RealmDownload: description: Download the users and groups for specific SAML realm. properties: realm: $ref: '#/components/schemas/RealmReference' description: The reference to the Realm that need to download type: object type: description: Type of information. This value is always 'RealmDownload'. type: string type: object EndPointDeviceType: properties: description: type: string fqName: type: string id: type: string iseId: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object NetworkObject: description: A model representing Network object definition. properties: description: description: 'User provided resource description. ' type: string id: description: Unique identifier representing response object. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of NetworkObject. type: object name: description: User assigned resource name. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: 'Type associated with resource: NetworkObject.' type: string value: description: Actual value of the network. type: string version: description: Version number of the response object. type: string type: object MacAddressPoolOverrideListContainer: properties: items: $ref: '#/components/schemas/MacAddressPoolOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object RouteMap: description: The route map object. properties: description: description: The route map object. type: string entries: description: The list of Route Map entries associated with this object. items: $ref: '#/components/schemas/IRouteMapEntry' type: object type: array id: description: Unique identifier type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Metadata associated with this object. type: object name: description: Name of the Route Map type: string overridable: description: If set to true, this object can be overriden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: RouteMap - type of this object type: string version: description: Version number of the response object. type: string required: - entries - name type: object SSOServerListContainer: properties: items: $ref: '#/components/schemas/SSOServer' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IGroupPolicyAdvancedSettingsModel: description: Model representiing the Configurations for Advanced Settings for Group Policy. properties: restrictVPNToVLANId: description: Optional. Specifies the egress VLAN for remote access VPN sessions assigned to this group policy. The range is 1-4094.There is no default value. format: int32 type: integer sessionSettings: $ref: '#/components/schemas/IGroupPolicySessionSettingsModel' description: Optional. Configures Session paramaters for VPN type: object vpnTrafficFilterACL: $ref: '#/components/schemas/IReference' description: Optional. Represents vpn-filter acl to post-decrypted traffic after it exits a tunnel and pre-encrypted traffic before it enters a tunnel. The ACL should be configured with the client assigned IP addresses as source and local network ip as destination in ACL. type: object type: object VariableSetVarDef: properties: excluded: $ref: '#/components/schemas/VarDef' type: object id: type: string included: $ref: '#/components/schemas/VarDef' type: object links: $ref: '#/components/schemas/ILinks' type: object name: type: string systemDefined: type: boolean type: type: string type: object VlanTag: description: A model representing tag object definition. properties: data: $ref: '#/components/schemas/IVlanTagLiteral' description: Object containing starting and ending VLAN identifier (VID) specifying the VLAN to which the frame belongs. type: object description: description: User provided resource description. type: string id: description: Unique identifier representing response object. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User assigned resource name. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object GeoLocationObject: description: Represents a GeoLocation containing various Countries and Continents. properties: continentId: description: This field is deprecated and should not be used. format: int32 type: integer continentUUID: description: This field is deprecated and should not be used. type: string continents: description: List of objects representing continents. items: $ref: '#/components/schemas/IContinentModel' type: object type: array countries: description: List of objects representing countries. items: $ref: '#/components/schemas/ICountryModel' type: object type: array description: description: This field is deprecated and should not be used. type: string id: description: Unique identifier (UUID) for the geolocation. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for the geolocation. type: object name: description: User-specified name of the geolocation. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always GeoLocationObject. type: string version: description: Version number of the response object. type: string type: object INetworkObjectsContainer: properties: literals: items: $ref: '#/components/schemas/INetworkAddressLiteral' type: object type: array objects: items: $ref: '#/components/schemas/INetworkBase' type: object type: array type: object IReadonly: properties: reason: enum: - RBAC - SYSTEM - DOMAIN type: string state: type: boolean type: object ISnort3IntrusionRuleGroupSecLevels: description: Object representing the security levels of Snort 3 intrusion rulegroup. properties: description: description: Description of the Snort 3 intrusion rulegroup. type: string level: description: Security levels of a Snort 3 intrusion rulegroup. enum: - DISABLED - LEVEL_1 - LEVEL_2 - LEVEL_3 - LEVEL_4 - DEFAULT type: string warning: description: Warning for each level of Snort 3 intrusion rulegroup type: string type: object CustomSIURLListListContainer: properties: items: $ref: '#/components/schemas/CustomSIURLList' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ICipherSuiteLiteral: properties: type: type: string type: object StandardCommunityList: description: Represents a StandardCommunityList. properties: entries: description: List of standard or expanded community entries that this object holds items: $ref: '#/components/schemas/IStandardCommunityListEntry' type: object type: array id: description: Unique identifier for the standard community list. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Metadata associated with this object. type: object name: description: Specifies a unique name assigned to this list type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always StandardCommunityList. type: string version: description: Version number of the response object. type: string required: - name type: object SseProxyData: properties: id: type: string name: type: string type: object ILinks: description: This defines the self referencing links for the given resource. properties: parent: description: Full resource URL path to reference the parent (if any) for this resource. type: string self: description: Full resource URL path to reference this particular resource. type: string type: object DHCPIPv6Pool: properties: description: type: string dnsServer: $ref: '#/components/schemas/IDHCPIPv6DNSServer' type: object domainName: $ref: '#/components/schemas/IDHCPIPv6DomainName' type: object id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string otherServerOptions: items: $ref: '#/components/schemas/DHCPIPv6OtherServerOptions' type: object type: array overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object ApplicationProductivity: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object IApplicationModel: description: Represents an ApplicationModel containing Application Types, Tags, Productivity, Risk, and Categories. properties: appId: description: Application Identifier stored in internal database (VDB). format: int32 type: integer applicationTypes: description: List of objects representing application types. items: $ref: '#/components/schemas/IApplicationType' type: object type: array categories: description: List of objects representing application categories. items: $ref: '#/components/schemas/IApplicationCategory' type: object type: array deprecated: description: Boolean representing if the application has been deprecated. type: boolean description: description: Application resource description. type: string id: description: Unique identifier (UUID) for the application. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the application model. type: object name: description: Name of the application. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object productivity: $ref: '#/components/schemas/IApplicationProductivity' description: The application productivity associated with this application. type: object risk: $ref: '#/components/schemas/IApplicationRisk' description: The application risk associated with this application. type: object tags: description: List of objects representing application tags. items: $ref: '#/components/schemas/IApplicationTag' type: object type: array type: description: Type of the response object. This value is always Application. type: string version: description: Version number of the response object. type: string type: object AzureADUserOrGroup: description: User or group of users from an Azure AD server. properties: description: type: string id: description: UUID of the Azure AD user or group. type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: description: Name of the Azure AD user or group. type: string realm: $ref: '#/components/schemas/LightAzureADRealm' description: 'A light object of Azure AD realm that contains 3 fields: id, name, type.' type: object type: description: Value is 'AzureADRealmUser' or 'AzureADRealmUserGroup'. Read only fixed value. type: string version: type: string type: object SLAMonitorObjectModelListContainer: properties: items: $ref: '#/components/schemas/SLAMonitorObjectModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IVpnPkcs12ContentModel: description: A model representing definition specific fields related to PKCS12 Certificate Enrollment. properties: base64Certificate: description: represents PKCS12 file content in Base64 format. type: string passPhrase: description: 'represents pass phrase value for decryption. ' type: string type: object ContinentObjectListContainer: properties: items: $ref: '#/components/schemas/ContinentObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IIPvPrefixListEntry: properties: action: enum: - PERMIT - DENY type: string ipAddress: type: string maxPrefixLength: format: int32 type: integer minPrefixLenth: format: int32 type: integer sequence: format: int32 type: integer required: - sequence type: object VariableSetListContainer: properties: items: $ref: '#/components/schemas/VariableSet' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DynamicObjectMappingsListContainer: properties: items: $ref: '#/components/schemas/DynamicObjectMappings' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IStandardACLEntry: description: Standard Access List entry properties: action: description: 'Indicate the redistribution access: PERMIT or DENY' enum: - PERMIT - DENY type: string networks: $ref: '#/components/schemas/INetworkObjectsContainer' description: The network objects/groups assoicated with this object type: object required: - action - networks type: object DownloadInternalCA: description: Download Internal CA PKCS 12 file encrypted with provided password. properties: fileName: type: string filePath: type: string id: description: UUID of the internal CA object to be downloaded.. type: string password: description: Password to encrypt the file with before downloading it. type: string type: description: ' A UTF8 string that represents the class-type. This corresponds to the class name. Fixed value of ''DownloadInternalCA''' type: string required: - id - password type: object ApplicationTypeListContainer: properties: items: $ref: '#/components/schemas/ApplicationType' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object RealmUserMetadata: description: An object representing the metadata of the RealmUser. properties: domain: $ref: '#/components/schemas/Domain' type: object forPolicy: description: Field representing if this user can be used in a policy. type: boolean isLocked: type: boolean lastSeen: description: Field representing timestamp of the last login for the user. format: int32 type: integer lastSynced: description: Field representing timestamp of the last sync for the user. format: int32 type: integer lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object resolved: description: Field representing if this can be resolved to a synced entity. type: boolean timestamp: format: int32 type: integer type: object VlanTagGroupOverride: description: A model representing tag group override definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Always returns flase for overrides. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object IExternalCACertificateBase: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object SecurityGroupTag: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object tag: format: int32 type: integer type: type: string version: type: string type: object TimeZoneObjectOverride: properties: description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object MacAddressPoolListContainer: properties: items: $ref: '#/components/schemas/MacAddressPool' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object CustomSIIPList: description: Object representing a static list of Network addresses uploaded by the user properties: description: type: string fileName: description: Name of the custom Security Intelligence Network List file as specified by user. type: string files: items: $ref: '#/components/schemas/IFileWrapper' type: object type: array filesMap: $ref: '#/components/schemas/LLFilesMap' type: object id: description: Unique identifier of custom Security Intelligence Network List object. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/CustomSIListMetadata' description: Object representing metadata attributes for the CustomSIIPList object. type: object name: description: Name of the custom Security Intelligence Network List object. type: string type: description: Must be CustomSIIPListObject type: string validateOnly: description: Validate the uploaded list file only. By default is set to false. type: boolean version: description: Version number of the response object. type: string type: object FQDNOverride: description: A model representing FQDN Network object override definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Always return false for overrides. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object InternalCertificate: description: Represents the server public key certificate object belonging to the user's organization. properties: cert: description: PEM, DER, or PKCS#7 formatted certificate contents. type: string certFingerprint: description: Unique sequence used to identify the certificate. type: string commitId: type: string description: type: string id: description: Unique identifier representing resource. type: string issuerCommonName: description: Common name of the issuer that signed and issued the certificate. type: string issuerOrganization: description: Organization, company name, of the issuer that signed and issued the certificate. type: string issuerOrganizationUnit: description: Organization Unit, division or unit, of the issuer that signed and issued the certificate. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: description: User chosen resource name. type: string passPhrase: description: Passphrase used for encrypted private key. type: string privateKey: description: PEM, DER, or PKCS#7 formatted key contents. type: string publicKeyFingerprint: description: SHA1 hash sequence used to identify the public key. type: string serialNumber: description: Unique number assigned by CA to the certificate on generation. The issuer name and serial number identify a unique certificate. type: string subjectCommonName: description: Common name of the subject being certified in the given certificate. type: string subjectCountry: description: An ISO3166 two character country code of the subject being certified in the given certificate. type: string subjectLocality: description: An Unicode alphanumeric string containing the locality, city name, of the subject being certified in the given certificate. type: string subjectOrganization: description: Organization, company name, of the subject being certified in the given certificate. type: string subjectOrganizationUnit: description: The Organization Unit, division or unit, of the subject being certified in the given certificate. type: string subjectState: description: An Unicode alphanumeric string containing the state or the province of the subject being certified in the given certificate. type: string type: description: Type of the response object. This value is always 'InternalCertificate'. type: string validityEndDate: description: Certificate validity end date in ISO 8601 format. type: string validityStartDate: description: Certificate validity start date in ISO 8601 format. type: string type: object GlobalTimeZone: description: Object representing a global time zone from IANA time zone (tz) database. properties: id: description: Unique identifier of the global time zone from the IANA time zone (tz) database. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing related links. type: object name: type: string timeZone: description: Description of the time zone with its UTC offset. type: string type: description: Type of the response object. This value is always GlobalTimeZone. type: string type: object SecurityZoneObject: description: A model representing zone object definition. properties: description: description: User provided resource description. type: string devices: items: $ref: '#/components/schemas/IInterfaceDeviceModel' type: object type: array id: description: Unique identifier of response object. type: string interfaceMode: enum: - PASSIVE - INLINE - SWITCHED - ROUTED - ASA type: string interfaces: description: Objects representing interfaces belonging to security zone. items: $ref: '#/components/schemas/IFTDInterface' type: object type: array links: $ref: '#/components/schemas/ILinks' description: Object containing related links. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object subType: type: string type: description: 'Type associated with resource: SecurityZone.' type: string version: description: Version number of the response object. type: string type: object IProxy: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object InternalCA: description: Represents the CA public key certificate of a CA the user's organization controls. Internal CA objects can be used in encryption policy rules to decrypt outgoing encrypted traffic by re-signing the server certificate with the internal CA. properties: cert: description: PEM, DER, or PKCS#7 formatted certificate contents. type: string certFingerprint: description: Unique sequence used to identify the certificate. type: string csr: description: PEM-formatted Certificate Signing Request contents which can be sent to CA for signing a certificate. type: string description: type: string id: description: Unique identifier representing resource. type: string issuerCommonName: description: Common name of the issuer that signed and issued the certificate. type: string issuerOrganization: description: Organization, company name, of the issuer that signed and issued the certificate. type: string issuerOrganizationUnit: description: Organization Unit, division or unit, of the issuer that signed and issued the certificate. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: description: User chosen resource name. type: string passPhrase: description: Passphrase used for encrypted private key. type: string privateKey: description: PEM, DER, or PKCS#7 formatted key contents. type: string publicKeyFingerprint: description: SHA1 hash sequence used to identify the public key. type: string serialNumber: description: Unique number assigned by CA to the certificate on generation. The issuer name and serial number identify a unique certificate. type: string subjectCommonName: description: Common name of the subject being certified in the given certificate. type: string subjectCountry: description: An ISO3166 two character country code of the subject being certified in the given certificate. type: string subjectLocality: description: An Unicode alphanumeric string containing the locality, city name, of the subject being certified in the given certificate. type: string subjectOrganization: description: Organization, company name, of the subject being certified in the given certificate. type: string subjectOrganizationUnit: description: The Organization Unit, division or unit, of the subject being certified in the given certificate. type: string subjectState: description: An Unicode alphanumeric string containing the state or the province of the subject being certified in the given certificate. type: string type: description: Type of the response object. This value is always 'InternalCA'. type: string validityEndDate: description: Certificate validity end date in ISO 8601 format. Defaulted to validity duration of 3650 days at the time of generation of self-signed certificate. type: string validityStartDate: description: Certificate validity start date in ISO 8601 format. Defaulted to current date and time in GMT zone at the self-sign certificate generation. type: string type: object ResourceProfileListContainer: properties: items: $ref: '#/components/schemas/ResourceProfile' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object InterfaceObject: properties: description: type: string devices: items: $ref: '#/components/schemas/IInterfaceDeviceModel' type: object type: array id: type: string interfaces: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object SINetworkFeedListContainer: properties: items: $ref: '#/components/schemas/SINetworkFeed' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ReferenceObject: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object NetworkGroupListContainer: properties: items: $ref: '#/components/schemas/NetworkGroup' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object FQDNObject: properties: description: type: string dnsResolution: enum: - IPV4_ONLY - IPV6_ONLY - IPV4_AND_IPV6 type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrideTargetId: type: string overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string value: type: string version: type: string required: - dnsResolution type: object IInterfaceObjectModel: properties: description: type: string devices: items: $ref: '#/components/schemas/IInterfaceDeviceModel' type: object type: array id: type: string interfaces: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object NetworkGroup: description: A model representing Network group definition. properties: description: description: 'User provided resource description. ' type: string id: description: Unique identifier of response object. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object literals: description: List of network values in group. items: $ref: '#/components/schemas/INetworkAddressLiteral' type: object type: array metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string objects: description: The list of member network objects items: $ref: '#/components/schemas/INetworkAddress' type: object type: array overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: 'Type associated with resource: NetworkGroup.' type: string version: description: Version number of the response object. type: string type: object FQDNObjectListContainer: properties: items: $ref: '#/components/schemas/FQDNObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object NetworkOverride: description: A model representing Network Override object definition. properties: description: description: User provided description. type: string id: description: Unique UUID representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Always returns false for overrides. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object AnyConnectCustomAttributeOverride: description: AnyConnect Custom Attribute override objects represent custom attribute used in configurations, typically for remote access VPN policies. They can contain override custom attribute in AnyConnect. properties: description: description: User provided resource description. type: string id: description: Unique identifier representing the AnyConnect Package object. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for the AnyConnect Package. type: object name: description: User provided resource name. type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: description: 'Type associated with resource: AnyConnectPackage.' type: string version: type: string type: object DynamicObjectsBulk: properties: add: items: $ref: '#/components/schemas/DynamicObject' type: object type: array description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string remove: $ref: '#/components/schemas/DynamicObjectBulkRemove' type: object type: type: string version: type: string type: object AnyConnectCustomAttributeOverrideListContainer: properties: items: $ref: '#/components/schemas/AnyConnectCustomAttributeOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object SIFeedMetadata: properties: domain: $ref: '#/components/schemas/Domain' type: object entryCount: format: int32 type: integer feedUpdateTime: format: int32 type: integer isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object timestamp: format: int32 type: integer validEntries: items: type: string type: array type: object ApplicationFilterListContainer: properties: items: $ref: '#/components/schemas/ApplicationFilter' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DistinguishedNameGroupListContainer: properties: items: $ref: '#/components/schemas/DistinguishedNameGroup' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object SSOServer: description: A model representing SSO Server Object definition. properties: baseUrl: description: URL provided to third-party IdPs to redirect end users back to the ASA type: string description: description: User provided resource description. type: string id: description: Unique identifier of response object.. type: string identityProviderCert: $ref: '#/components/schemas/IReference' type: object idpEntityId: description: SAML Identity Provider entityID type: string links: $ref: '#/components/schemas/Links' type: object logoutURL: description: 'URL or IP address at which the SAML provider will accept incoming requests to log out. ' type: string metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: type: string overrides: $ref: '#/components/schemas/IOverride' type: object reAuthAtLogin: description: Boolean indicating whether users are required to reauthenticate when logging into the SAML server. type: boolean requestSignatureType: description: ' Possible values include NO_SIGNATURE|RSA_SHA1|RSA_SHA256|RSA_SHA384|RSA_SHA512' type: string requestTimeout: description: Timeout set by the provider. Allowed range is 1-7200 seconds. Default value is 0 format: int32 type: integer serverOnInternalNetwork: description: Indicates the SAML provider in on an inside network, default value is false type: boolean serviceProviderCert: $ref: '#/components/schemas/IReference' type: object ssoURL: description: URL or IP address at which the SAML provider will accept incoming requests to authenticate a user type: string type: description: 'Type associated with resource: SSOServer.' type: string version: description: Version number of the response object. type: string required: - identityProviderCert - idpEntityId - ssoURL type: object IPv6PrefixListListContainer: properties: items: $ref: '#/components/schemas/IPv6PrefixList' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object RangeOverrideListContainer: properties: items: $ref: '#/components/schemas/RangeOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object PolicyList: description: A policy list for use in a route map for Border Gateway Protocol (BGP). properties: action: description: 'Action to take for this matching criteria: PERMIT or DENY' enum: - PERMIT - DENY type: string asPathLists: description: BGP autonomous system path for matching criteria. items: $ref: '#/components/schemas/IReference' type: object type: array communityLists: description: The route can match either community items: $ref: '#/components/schemas/IReference' type: object type: array description: type: string extendedCommunityLists: description: The route can match this extendedcommunity items: $ref: '#/components/schemas/IReference' type: object type: array id: description: unique object identifier type: string interfaceNames: description: Interface logical names associated with this object items: type: string type: array interfaces: description: Add the Security zones/Interface groups that contain the interfaces through which the device communicates with the management station items: $ref: '#/components/schemas/IReference' type: object type: array ipv4PrefixListAddresses: description: A destination address that is permitted by a prefix list (standardAccessListAddresses and ipv4PrefixListAddresses are mutually exclusive) items: $ref: '#/components/schemas/IReference' type: object type: array ipv4PrefixListNexthops: description: A next hop router address passed by one of the prefix lists specified.(standardAccessListNextHops and ipv4PrefixListAddresses are mutually exclusive) items: $ref: '#/components/schemas/IReference' type: object type: array ipv4PrefixListRouteSources: description: Routes that have been advertised by routers and access servers at the address specified by the prefix lists. items: $ref: '#/components/schemas/IReference' type: object type: array links: $ref: '#/components/schemas/Links' type: object matchCommunityExactly: description: Match the BGP community exactly with the specified community type: boolean metadata: $ref: '#/components/schemas/Metadata' type: object metric: description: This setting allows you to match any routes that have a specified metric. The metric values can range from 0 to 4294967295. format: int32 type: integer name: description: Name for the policy list object type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object standardAccessListAddresses: description: A destination address that is permitted by a standard access list (standardAccessListAddresses and ipv4PrefixListAddresses are mutually exclusive) items: $ref: '#/components/schemas/IReference' type: object type: array standardAccessListNextHops: description: A next hop router address passed by one of the access lists specified. (standardAccessListNextHops and ipv4PrefixListAddresses are mutually exclusive) items: $ref: '#/components/schemas/IReference' type: object type: array standardAccessListRouteSources: description: Routes that have been advertised by routers and access servers at the address specified by the access lists. items: $ref: '#/components/schemas/IReference' type: object type: array tag: description: This setting allows you to match any routes that have a specified security group tag. The tag values can range from 0 to 4294967295 format: int32 type: integer type: description: PolicyList - type of this object type: string version: type: string required: - action - name type: object NetworkAddress: description: A model representing Network Address definition representing parent of Network sub types. properties: description: type: string id: description: Unique identifier of response object. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Subtype of NetworkAddress (Host | Network | Range | NetworkGroup). type: string value: description: Actual value of child object. type: string version: description: Version number of the response object. type: string type: object IPv4AddressPoolListContainer: properties: items: $ref: '#/components/schemas/IPv4AddressPool' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ErrorMessagesContainer: properties: bulkPayloadIndex: description: More details about the error. type: string code: description: More details about the error. type: string description: description: More details about the error. type: string details: description: More details about the error. type: string errorCode: description: More details about the error. type: string location: description: More details about the error. type: string severity: description: Specifies the Highest level severity among all the error messages. enum: - ERROR - WARN type: string type: object ICMPV4ObjectOverrideListContainer: properties: items: $ref: '#/components/schemas/ICMPV4ObjectOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object Ikev2PolicyObjectListContainer: properties: items: $ref: '#/components/schemas/Ikev2PolicyObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DynamicObjectBulkRemove: properties: agentIds: items: type: string type: array ids: items: type: string type: array names: items: type: string type: array type: object VpnCertEnrollmentOverride: properties: description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object ITimeZoneDateRangeFragment: description: Object fragment to configure the daylight saving by date range. properties: endDateTime: description: Represents the date and time (in ISO 8601 format) at which the daylight saving with end. type: string offset: description: Number (in minutes) representing the offset from specified time zone. Offset value must be between 1-1440. format: int32 type: integer startDateTime: description: Represents the date and time (in ISO 8601 format) at which the daylight saving will start. type: string type: object ExternalCertificateGroupListContainer: properties: items: $ref: '#/components/schemas/ExternalCertificateGroup' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object RealmUser: description: Defines Identity RealmUser Object. properties: id: description: Unique Identifier of the user. type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/RealmUserMetadata' description: Metadata object of the RealmUser. type: object name: description: Name of the RealmUser. type: string realm: $ref: '#/components/schemas/IRealm' description: Realm object for the user. type: object type: description: Value is 'RealmUser'. Read-only fixed value. type: string type: object IPKICertRevocationListModel: properties: certRevocationStaticUrlList: items: type: string type: array enableCertRevocationList: type: boolean enableCertRevocationListDistributionPoint: type: boolean enableStaticCertRevocationList: type: boolean type: object CustomSIListMetadata: properties: domain: $ref: '#/components/schemas/Domain' type: object entryCount: format: int32 type: integer invalidEntryCount: format: int32 type: integer invalidLines: type: string isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object timestamp: format: int32 type: integer totalEntryCount: format: int32 type: integer type: object RuleImportSummary: description: An object that represents the details for imported Snort3 custom rules. properties: added: $ref: '#/components/schemas/RuleImportSummaryEntry' description: Specifies the details of added rule. type: object deleted: $ref: '#/components/schemas/RuleImportSummaryEntry' description: Specifies the details of deleted rule. type: object skipped: $ref: '#/components/schemas/RuleImportSummaryEntry' description: Specifies the details of skipped rule. type: object type: description: Type of the response object. This value is always ruleimportsummary. type: string unassociated: $ref: '#/components/schemas/RuleImportSummaryEntry' description: Specifies the details of unassociated rule. type: object updated: $ref: '#/components/schemas/RuleImportSummaryEntry' description: Specifies the details of updated rule. type: object type: object AsPathListListContainer: properties: items: $ref: '#/components/schemas/AsPathList' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object PortObjectListContainer: properties: items: $ref: '#/components/schemas/PortObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object AnyConnectExternalBrowserPackageModelListContainer: properties: items: $ref: '#/components/schemas/AnyConnectExternalBrowserPackageModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object RealmUserListContainer: properties: items: $ref: '#/components/schemas/RealmUser' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DynamicObjectWithMappingsBulk: properties: dynamicObject: $ref: '#/components/schemas/DynamicObjectBulk' type: object mappings: items: type: string type: array type: object IGroupPolicyClientModulesModel: description: Model representing the File configurations for AnyConnect Client Modules properties: enableModuleDownload: description: Specifies if the module has to be downloaded. Default is False type: boolean moduleProfile: $ref: '#/components/schemas/IReference' description: Represents VPN Client Profile Object type: object moduleType: description: Specifies the type of the Client module package enum: - AMP_ENABLER - FEEDBACK - ISE_POSTURE - NETWORK_ACCESS_MANAGER - NETWORK_VISIBILITY - UMBRELLA_ROAMING - WEB_SECURITY - START_BEFORE_LOGIN - DART type: string type: object ProtocolPortObjectListContainer: properties: items: $ref: '#/components/schemas/ProtocolPortObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IExtendedCommunityApiEntry: properties: action: type: string regularExpression: type: string routeTarget: type: string sequence: format: int32 type: integer type: object AzureADStatus: description: This object can be used to get Azure AD realm statuses. properties: description: type: string id: description: Connector ID from the CSDAC side, which serves as an identifier for Azure AD realms. type: string metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string status: $ref: '#/components/schemas/ConnectorStatusBody' description: An object containing the exact status value plus a description for more details or troubleshooting suggestions. type: object type: type: string version: type: string type: object IdpSettings: properties: certificate: $ref: '#/components/schemas/ReferenceObject' type: object certificateId: type: string entityId: type: string ssoUrl: type: string type: object AzureADRealmListContainer: properties: items: $ref: '#/components/schemas/AzureADRealm' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IPv6PrefixList: description: Prefix lists are used in route maps and route filtering operations and can be used as an alternative to access lists in many Border Gateway Protocol (BGP) route filtering commands. properties: description: description: User-provided object description. type: string entries: description: List of IP prefix entries that this object holds. items: $ref: '#/components/schemas/IIPvPrefixListEntry' type: object type: array id: description: Unique identifier (UUID) for the IPv6PrefixList. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for IPv6PrefixList. type: object name: description: The unique name for the IPv6PrefixList object. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type of IPv6PrefixList object. type: string version: description: Version number of the response object. type: string required: - name type: object DistinguishedName: description: Represents the distinguished name listed for a public key certificate's subject or issuer. properties: description: type: string dn: description: The value of the distinguished name. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: description: User chosen resource name. type: string type: description: Type of the response object. This value is always 'DistinguishedName'. type: string version: type: string type: object InternalCAListContainer: properties: items: $ref: '#/components/schemas/InternalCA' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IExtendedACLEntry: properties: action: enum: - PERMIT - DENY type: string applications: $ref: '#/components/schemas/IApplicationsContainer' type: object destinationNetworks: $ref: '#/components/schemas/INetworkObjectsContainer' type: object destinationPorts: $ref: '#/components/schemas/IPortObjectsContainer' type: object logInterval: format: int32 type: integer logLevel: enum: - EMERGENCY - ALERT - CRITICAL - ERROR - WARNING - NOTIFICATION - INFORMATIONAL - DEBUGGING type: string logging: enum: - PER_ACCESS_LIST_ENTRY - DEFAULT - DISABLED type: string securityGroupTags: $ref: '#/components/schemas/ISecurityGroupTagContainer' type: object sourceNetworks: $ref: '#/components/schemas/INetworkObjectsContainer' type: object sourcePorts: $ref: '#/components/schemas/IPortObjectsContainer' type: object users: $ref: '#/components/schemas/IUsersContainer' type: object required: - action - logLevel - logging type: object BFDTemplate: description: To have templates for Bidirectional Forwarding Detection routing protocol. properties: authentication: $ref: '#/components/schemas/IBFDTemplateAuthentication' description: Mandatory for multi-hop template, for single-hop template this is optional type: object echo: description: Enables BFD echo mode on an interface (ENABLED | DISABLED). enum: - ENABLED - DISABLED type: string hopType: description: SINGLE_HOP | MULTI_HOP enum: - SINGLE_HOP - MULTI_HOP type: string id: description: The unique UUID of this object. type: string links: $ref: '#/components/schemas/Links' description: Contains the full URL to the current object and it's parent (if any). type: object metadata: $ref: '#/components/schemas/Metadata' description: Defines read-only details about the object. type: object minReceive: description: Specifies the rate at which BFD control packets are expected to be received from BFD peers. format: int32 type: integer minTransmit: description: Specifies the rate at which BFD control packets are sent to BFD peers. format: int32 type: integer name: description: The unique name for the object. type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object txRxInterval: description: Interval Type (MILLISECONDS | MICROSECONDS | NONE). enum: - MILLISECONDS - MICROSECONDS - NONE type: string txRxMultiplier: description: The number of consecutive missed BFD packets before declaring that the peer is unavailable. format: int32 type: integer type: description: Type of the object. This value is always BFDTemplate. type: string version: description: The unique object version (if any). type: string type: object RealmReference: properties: id: type: string type: type: string type: object IDirectoryConfiguration: description: Represents directory server connection properties: connectivityStatus: enum: - ACTIVE - NOT_CONNECTED - ERROR type: string connectivityStatusTimestamp: format: int32 type: integer encryptionCert: $ref: '#/components/schemas/IExternalCACertificate' description: An object reference to a `ExternalCACertificate` certificate object on FMC used to connect to a server when using encryption. Must be specified if `LDAPS` or `STARTTLS` is used in `encryptionProtocol`. type: object encryptionProtocol: description: Field of the encryption protocol used when connecting to this directory server. Allowed values are 'NONE', 'LDAPS', or 'STARTTLS'. enum: - NONE - STARTTLS - LDAPS type: string hostname: description: Field to specify the hostname or IP address of the directory server. This is a required field. type: string id: description: Field indicating the order this directoryConfiguration should be used. format: int32 type: integer interface: $ref: '#/components/schemas/IInterfaceGroupObjectModel' description: An object reference to the SecurityZone used by RA-VPN configurations when using a realm for authentication, and it specifies which interface the device will use to contact the directory server. type: object port: description: 'Field of the port used to connect to the directory server. Allowed value are from 1 to 65535. ' format: int32 type: integer useRoutingToSelectInterface: description: Field used by RA-VPN configurations when using a realm for authentication, and it specifies whether the device will use predefined routing to connect to the directory server. type: boolean type: object IReference: description: Contains reference information. properties: id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object name: description: User chosen resource name. type: string type: description: Response object associated with resource. type: string type: object IExternalCertificate: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object ApplicationRisk: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object TimeRange: description: Object representing a time range object. properties: description: description: User provided resource description. type: string effectiveEndDateTime: description: Represents the absolute date and time (in ISO 8601 format) at which the time range object stops being effective. If not specified, value is considered, 'never ends'. type: string effectiveStartDateTime: description: Represents the absolute date and time (in ISO 8601 format) at which the time range object starts being effective. If not specified, value is considered, 'starts now'. type: string id: description: Unique identifier representing response object. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of the response object. type: object name: description: User assigned resource name. type: string recurrenceList: description: Represents the list of recurring intervals during which the time range is effective. These intervals are valid only between effectiveStartDateTime and effectiveEndDateTime. items: $ref: '#/components/schemas/IRecurrence' type: object type: array type: description: Type of the response object. This value is always TimeRange. type: string version: description: Version number of the response object. type: string required: - name type: object Snort3IntrusionRuleGroupMetadata: description: Object representing the metadata of rule group. properties: container: $ref: '#/components/schemas/IReference' description: Container reference of rule group. type: object domain: $ref: '#/components/schemas/Domain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array mitreId: description: Mitre Id of the rule group. type: string readOnly: $ref: '#/components/schemas/ReadOnly' type: object ruleCount: $ref: '#/components/schemas/ISnort3PolicyRuleCount' description: Rule count of each intrusion rule group. type: object securityLevels: items: $ref: '#/components/schemas/ISnort3IntrusionRuleGroupSecLevels' type: object type: array sortOrder: description: Sort order of the rule group. format: int32 type: integer timestamp: format: int32 type: integer type: object CommunityList: properties: expandedEntries: items: $ref: '#/components/schemas/IExpandedCommunityListEntry' type: object type: array id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object standardEntries: items: $ref: '#/components/schemas/IStandardCommunityListEntry' type: object type: array type: type: string version: type: string type: object IGroupPolicyGeneralSettingsModel: description: Model represents General Settings of a Group Policy properties: addressAssignment: $ref: '#/components/schemas/IGroupPolicyAddressAssignmentModel' description: Optional. Represents Address Assignment details that will be assigned to the endhost type: object banner: description: Optional. Specifies the banner text to present to users at login type: string primaryDNSServer: $ref: '#/components/schemas/IReference' description: Optional. Represents Network Object containing Primary DNS Server IP Address type: object primaryWINSServer: $ref: '#/components/schemas/IReference' description: Optional. Represents Network Object containing Primary WINS Server IP Address type: object secondaryDNSServer: $ref: '#/components/schemas/IReference' description: Optional. Represents Network Object containing Secondary DNS Server IP Address type: object secondaryWINSServer: $ref: '#/components/schemas/IReference' description: Optional. Represents Network Object containing Secondary WINS Server IP Address type: object splitTunnelSettings: $ref: '#/components/schemas/IGroupPolicySplitTunnelSettingsModel' description: Optional. Represents Split tunneling directs some network traffic through the VPN tunnel (encrypted) and the remaining network traffic outside the VPN tunnel (unencrypted) type: object type: object ISecurityGroupTagContainer: properties: literals: items: $ref: '#/components/schemas/ISecurityGroupTagLiteral' type: object type: array objects: items: $ref: '#/components/schemas/ISecurityGroupTag' type: object type: array type: object HostObject: description: An object defining a Host Network object definition. properties: description: description: A description about the object. type: string id: description: The unique UUID of this object. type: string links: $ref: '#/components/schemas/Links' description: Contains the full URL to the current object and its parent (if any) type: object metadata: $ref: '#/components/schemas/Metadata' description: Defines read only details about the object - whether it is system defined, last user who modified the object etc. type: object name: description: ' The unique name for the object.' type: string overridable: description: Set to 'true' if the object can be overridden, 'false' otherwise. type: boolean overrideTargetId: description: The override target id either the device (UUID) or the domain (UUID) on which this override is created. Applicable only for overriden objects. type: string overrides: $ref: '#/components/schemas/IOverride' description: This is populated only if this object is an override and contains the parent (global) object id and whether this is an override on device or domain. type: object type: description: The unique type of this object (fixed). type: string value: description: The Host IP address value for this object. type: string version: description: The unique object version (if any). type: string type: object TimeZoneObjectOverrideListContainer: properties: items: $ref: '#/components/schemas/TimeZoneObjectOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IApplicationsContainer: description: Represents an ApplicationsContainer containing application filters and applications. properties: applicationFilters: description: List of objects representing pre-defined application filters. items: $ref: '#/components/schemas/IApplicationFilter' type: object type: array applications: description: List of objects representing applications. items: $ref: '#/components/schemas/IApplicationModel' type: object type: array inlineApplicationFilters: description: List of objects representing application filters. items: $ref: '#/components/schemas/IAppCondition' type: object type: array type: object IUrlModel: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string url: type: string version: type: string type: object DynamicObjectBulk: properties: id: type: string name: type: string type: type: string type: object FileTypeModelListContainer: properties: items: $ref: '#/components/schemas/FileTypeModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object AnyConnectProfileModel: description: File objects represent AnyConnect Client Profile files. properties: description: description: User provided resource description. type: string fileName: description: Name of the AnyConnect client file type: string fileType: description: Type of the AnyConnect file enum: - ANYCONNECT_VPN_PROFILE - ANYCONNECT_MANAGEMENT_VPN_PROFILE - AMP_ENABLER - FEEDBACK - ISE_POSTURE - NETWORK_ACCESS_MANAGER - NETWORK_VISIBILITY - UMBRELLA_ROAMING - WEB_SECURITY type: string files: items: $ref: '#/components/schemas/IFileWrapper' type: object type: array filesMap: $ref: '#/components/schemas/LLFilesMap' type: object id: description: Unique identifier representing this resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User provided resource name. type: string type: description: 'Type associated with resource: AnyConnectProfile.' type: string version: type: string required: - fileName - fileType type: object RealmMetadata: description: An object representing the metadata of the realm. properties: domain: $ref: '#/components/schemas/Domain' type: object duplicatedDomain: description: Field represents whether an imported realm has 'adPrimaryDomain' that conflicts with an existing realm on the system. A realm with this flag set can not be enabled until the condition has been cleared. type: boolean hasUnresolvedReferences: description: Field represents whether this `Realm` has unresolved references. type: boolean isDownloading: description: Field represents whether a download task is in progress. type: boolean isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object systemDefined: description: Field represents whether this `Realm` can be seen by other policies. type: boolean timestamp: format: int32 type: integer type: object URLCategoryListContainer: properties: items: $ref: '#/components/schemas/URLCategory' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object CertificateMapModel: description: Certificate Map objects are a named set of certificate matching rules. These objects are used to provide an association between a received certificate and a Remote Access VPN connection profile. properties: description: type: string id: description: Unique identifier representing the CertificateMap object. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for the CertificateMap. type: object name: description: User-specified name of the Certificate Map type: string rules: items: $ref: '#/components/schemas/ICertificateMapRules' type: object type: array type: description: 'Type associated with resource: CertificateMap.' type: string version: type: string type: object IInternalCertificate: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object IGroupPolicyCustomAttributesModel: description: Model representing the configuration of Custom Attributes of the Group Policy properties: anyConnectAttribute: description: Represents values of either (PER_APP_VPN|ALLOW_DEFER_UPDATE|DYNAMIC_SPLIT_TUNNELING|CUSTOM_TYPE) specifying type of AnyConnect custom attribute type: string customAttributeObject: $ref: '#/components/schemas/IReference' description: Represents AnyConnect custom attribute object of selected type type: object type: object Realm: description: Defines Identity Realm Object. properties: activeAuthSessionTimeout: description: Field for the amount of time in minutes a user session is held onto without receiving another login event for sessions from captive portal. Allowed values are from 0 to 35791394. Default value is 1440. format: int32 type: integer adJoinPassword: description: Field to specify the password corresponding to the user in `ad_join_username` when joining an Active Directory domain. Used only for active authentication / captive portal sessions when Kerberos authentication is being used. It must not be empty when 'adJoinUsername' is set. It will be shown as '*********' (nine asterisks), If a field contains '*********' (nine asterisks) on a PUT, we will try to load the password from the existing object. type: string adJoinUsername: description: Field to specify the username when joining an Active Directory domain. Used only for active authentication / captive portal sessions when Kerberos authentication is being used. type: string adPrimaryDomain: description: Field to specify the domain served by Active Directory. Sessions with users that match this domain will be associated with this realm. It must be unique. If this field is empty, first Directory Server will be queried for its value. If query fails, user must provide a value. type: string authSessionTimeout: description: Field for the amount of time in minutes a user session is held onto without receiving another login event for sessions from ISE. Allowed values are from 0 to 35791394. Default value is 1440. format: int32 type: integer baseDn: description: Field that specifies the distinguished name (DN) where we start the search for users and groups from the directory server. If this field is empty, first Directory Server will be queried for its value. If query fails, user must provide a value. type: string configurationType: enum: - DOWNLOADING - AUTHENTICATING_AND_DOWNLOADING type: string description: description: Description of the realm. Field is not guaranteed to be safe to display in the UI without escaping HTML characters. type: string dirPassword: description: Field to specify the password corresponding to the user in ldapUsername used when sync'ing (downloading) user directory information. Must not be empty for POST. It will be shown as '*********' (nine asterisks), If a field contains '*********n (nine asterisks) on a PUT, we will try to load the password from the existing object. type: string dirUsername: description: Field to specify the username used when sync'ing (downloading) user directory information. Must not be empty for POST. type: string directoryConfigurations: description: Represents all known directory server connections. They are expected to return the same results, and if one server cannot be contacted, then the next one will be used. items: $ref: '#/components/schemas/IDirectoryConfiguration' type: object type: array enabled: description: Field represents whether this `Realm` can be used by other policies. type: boolean excludedGroups: description: Fields of the group names that are configured to be excluded in the download. items: type: string type: array excludedUsers: description: Fields of the user names that are configured to be excluded in the download. items: type: string type: array failedAuthSessionTimeout: description: Field for the amount of time in minutes a user session is held onto without receiving another login event for failed authentication sessions. Allowed values are from 0 to 35791394. Default value is 1440. format: int32 type: integer groupAttribute: description: Field that specifies which `LDAP` attribute we use to determine group membership. type: string groupDn: description: Field that specifies the distinguished name (DN) where we start the search for groups from the directory server. If this field is empty, first Directory Server will be queried for its value. If query fails, user must provide a value type: string guestSessionTimeout: description: Field for the amount of time in minutes a user session is held onto without receiving another login event for guest user sessions. Allowed values are from 0 to 35791394. Default value is 1440. format: int32 type: integer id: description: Unique Identifier, in `UUID` format, of the realm. This field is required for PUT but cannot be included in a POST request. type: string identityConnector: $ref: '#/components/schemas/AzureADConnector' type: object identityProvider: type: string idpSettings: $ref: '#/components/schemas/IdpSettings' type: object includedGroups: description: Fields of the user names that are configured to be included in the download. items: type: string type: array includedUsers: description: Fields of the user names that are configured to be included in the download. items: type: string type: array links: $ref: '#/components/schemas/ILinks' description: Self link type: object metadata: $ref: '#/components/schemas/RealmMetadata' description: Metadata object of the realm type: object name: description: Name of the realm. It must be unique and must not be empty for POST. It is not guaranteed to be safe to display in the UI without escaping HTML characters. type: string proxy: $ref: '#/components/schemas/IProxy' type: object realmId: description: Field for the internal id of the realm. It is a read-only field, not to be set for any operation. format: int32 type: integer realmType: description: Type of the realm. User-specified values can be 'AD' or 'LDAP'. System-specified values may also include Special and Discovered. Once realmType has been set during object creation, it cannot be changed. enum: - AD - LDAP - LOCAL - DISCOVERED - SPECIAL - AZURE_AD - SAML type: string samlSessionTimeout: format: int32 type: integer spSettings: $ref: '#/components/schemas/SpSettings' type: object tsAgentSessionTimeout: description: Field for the amount of time in minutes a user session is held onto without receiving another login event for sessions from TSAgent. Allowed values are from 0 to 35791394. Default value is 1440. format: int32 type: integer type: description: Value is 'Realm'. Read only fixed value. type: string updateHour: description: Field for the hour where the sync (download) from the directory starts. Allowed values are from 0 to 23. Default value is 0. format: int32 type: integer updateInterval: description: Field for the frequency in hours of the sync (download). Allowed values are 1,2,3,4,8,12 or 24. Default value is 24. format: int32 type: integer version: description: Revision, in `UUID` format, of the realm. Must be present for PUT, but not for POST. IT must be the same as last saved objecti for PUT. type: string type: object GroupPolicyModelListContainer: properties: items: $ref: '#/components/schemas/GroupPolicyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object SINetworkList: description: Object representing a user-specified third-party list. properties: description: description: Description of the Security Intelligence list. type: string fileName: description: Name of the custom Security Intelligence Network list file as specified by user. type: string id: description: Unique identifier representing the Security Intelligence Network list. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/SIListMetadata' description: Object representing metadata attributes for the SINetworkList object. type: object name: description: Name of the Security Intelligence Network List object. type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: description: Type must be SINetworkList. type: string version: description: Version number of the response object. type: string type: object KeyChainObject: properties: description: type: string id: type: string keys: items: $ref: '#/components/schemas/IKeyObject' type: object type: array links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrideTargetId: type: string overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object AzureADUserOrGroupListContainer: properties: items: $ref: '#/components/schemas/AzureADUserOrGroup' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object SIURLList: description: Object representing a user-specified third-party list. properties: description: description: Description of the Security Intelligence list. type: string fileName: description: Name of the custom Security Intelligence URL list file as specified by user. type: string id: description: Unique identifier representing the Security Intelligence URL list. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object listType: format: int32 type: integer metadata: $ref: '#/components/schemas/SIListMetadata' description: Object representing metadata attributes for the SIURLList object. type: object name: description: Name of the Security Intelligence URL List object. type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: description: Type must be SIURLList. type: string version: description: Version number of the response object. type: string type: object InterfaceGroupObjectListContainer: properties: items: $ref: '#/components/schemas/InterfaceGroupObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object HostScanPackageObject: properties: description: type: string fileName: type: string fileType: enum: - ANYCONNECT_VPN_PROFILE - ANYCONNECT_MANAGEMENT_VPN_PROFILE - AMP_ENABLER - FEEDBACK - ISE_POSTURE - NETWORK_ACCESS_MANAGER - NETWORK_VISIBILITY - UMBRELLA_ROAMING - WEB_SECURITY type: string files: items: $ref: '#/components/schemas/IFileWrapper' type: object type: array filesMap: $ref: '#/components/schemas/LLFilesMap' type: object id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string type: type: string version: type: string type: object Variable: properties: description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string type: type: string value: type: string variableType: enum: - STRING - AS_NUMBER - IPV4_NETWORK - IPV4_HOST - IPV6_NETWORK - IPV6_HOST - PASSWORD - ROUTER_ID - IPV4_RANGE - FQDN type: string version: type: string type: object VlanTagGroup: description: A model representing tag group definition. properties: description: description: User provided resource description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object literals: description: List of tag values in group. items: $ref: '#/components/schemas/IVlanTagLiteral' type: object type: array metadata: $ref: '#/components/schemas/Metadata' type: object name: description: User assigned resource name. type: string objects: description: List of member vlan tags in this group items: $ref: '#/components/schemas/IVlanModel' type: object type: array overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: 'Type associated with resource: VlanTagGroup.' type: string version: description: Version number of the response object. type: string type: object RealmListContainer: properties: items: $ref: '#/components/schemas/Realm' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object VpnCertEnrollmentModel: description: A model representing Certificate Enrollment Object definition. properties: caCertificate: $ref: '#/components/schemas/ICertEnrollManualCaCertificateModel' description: Specifies CA Certificate info in base64 format for Manual enroll type and CA flag type: object certificateParameters: $ref: '#/components/schemas/ICertificateParametersModel' type: object description: description: User provided resource description. type: string enrollmentType: description: User chosen enrollment type.Possible values are SCEP/EST/Manual/SelfSignedCertficate/Pkcs12. enum: - SCEP - EST - MANUAL - SELF_SIGNED_CERTFICATE - PKCS12 type: string estContent: $ref: '#/components/schemas/IVpnEstContentModel' type: object id: description: Unique identifier of response object. type: string key: $ref: '#/components/schemas/IPKIServerKeyModel' type: object links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object pkcs12Content: $ref: '#/components/schemas/IVpnPkcs12ContentModel' description: Specifies PKCS12 certificate in base64 format and the passPhrase. type: object revocation: $ref: '#/components/schemas/IPKIRevocationModel' type: object scepContent: $ref: '#/components/schemas/IVpnScepContentModel' type: object skipCaFlagCheck: description: Specifices flag to skip checking the basic constraints extension and the CA flag in a trustpoint certificate. type: boolean subType: enum: - SA_CLIENT_CERT_CA_CHAIN - SA_REDIRECT_TOKEN_SIGN_CERT - SA_REDIRECT_TOKEN_ENCRYPT_CERT_KEY - SA_ROOT_CA - SA_INTERMEDIATE_CA - SA_ORG_CA type: string type: description: 'Type associated with resource: CertEnrollment.' type: string validationUsage: $ref: '#/components/schemas/IPKIValidationUsageModel' type: object version: type: string type: object IIntrusionPolicyModel: properties: basePolicy: $ref: '#/components/schemas/IReference' description: Representing policy details which is used as base for current policy. This field is not present for preprovisioned intrusioned policies. type: object id: description: Intrusion Policy UUID type: string inlineDrop: description: Indicates the inspection mode <0 or 1> format: int32 type: integer inspectionMode: description: Only applicable for SNORT3. Possible values could be DETECTION or PREVENTION enum: - PREVENTION - DETECTION type: string isSystemDefined: type: boolean links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object name: description: Name of the intrusion policy type: string ruleRecommendation: $ref: '#/components/schemas/IRuleRecommendation' type: object snortEngine: description: Possible values could be SNORT2 or SNORT3 enum: - SNORT2 - SNORT3 type: string sseProxyData: $ref: '#/components/schemas/SseProxyData' type: object type: description: Type must be intrusionpolicy type: string type: object RangeObject: description: A model representing Range Network object definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Contains the full URL to the current object and its parent (if any) type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path query parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: This is populated only if this object is an override and contains the parent (global) object id and whether this is an override on device or domain. type: object type: description: The unique type of this object. type: string value: description: Actual value of range. type: string version: description: Version number of the response object. type: string type: object SecurityZoneObjectListContainer: properties: items: $ref: '#/components/schemas/SecurityZoneObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ExpandedCommunityListListContainer: properties: items: $ref: '#/components/schemas/ExpandedCommunityList' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object PortObjectGroupOverride: description: A model representing port object group override definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on device or domain. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object SIURLFeedListContainer: properties: items: $ref: '#/components/schemas/SIURLFeed' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DynamicObjectMetadata: properties: domain: $ref: '#/components/schemas/Domain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object mappingsCount: format: int32 type: integer matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object timestamp: format: int32 type: integer type: object RouteMapListContainer: properties: items: $ref: '#/components/schemas/RouteMap' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object PagingContainer: properties: count: format: int32 type: integer limit: format: int32 type: integer offset: format: int32 type: integer pages: format: int32 type: integer type: object DHCPIPv6OtherServerOptions: properties: address: $ref: '#/components/schemas/IDHCPIPv6DNSServer' type: object domainName: $ref: '#/components/schemas/IDHCPIPv6DomainName' type: object option: enum: - NIS - NISP - SIP - SNTP type: string type: object PortObject: description: A model representing port object definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/PortMetadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object IPKIOnlineCertificateStatusProtocolModel: properties: enableOnlineCertificateStatusProtocol: type: boolean onlineCertificateStatusProtocolUrl: type: string type: object IDistinguishedName: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object FileCategoryModel: description: Object representing a FileCategory object within a FileRule. properties: description: description: Description of the file rule. type: string fileTypes: description: Contains a list of file types in the given category. items: type: object type: array id: description: Unique identifier representing the FileCategory. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object malwareCount: description: A number of file types within the fileTypes field. format: int32 type: integer metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the FileCategory object. type: object name: description: Name of the FileCategory object. type: string type: description: Type must be FileCategory. type: string version: description: Version number of the response object. type: string type: object IPortObjectsContainer: properties: literals: items: $ref: '#/components/schemas/IBasePortLiteral' type: object type: array objects: items: $ref: '#/components/schemas/IPortObject' type: object type: array type: object PrivateResourceGroup: properties: certificate: $ref: '#/components/schemas/IReference' type: object description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string objects: items: $ref: '#/components/schemas/IPrivateResourceModel' type: object type: array reachableAddresses: items: $ref: '#/components/schemas/INetworkObjectsContainer' type: object type: array resourceAddresses: items: $ref: '#/components/schemas/IHybridResourceAddressesContainer' type: object type: array ssePrivateResourceId: format: int32 type: integer targets: items: $ref: '#/components/schemas/IReference' type: object type: array type: type: string version: type: string type: object IDomain: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object RangeOverride: description: A model representing range object override definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Always returns false for overrides. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object VpnCertEnrollmentOverrideListContainer: properties: items: $ref: '#/components/schemas/VpnCertEnrollmentOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object PortOverlapsContainer: properties: literals: items: $ref: '#/components/schemas/PortLiteralOverlaps' type: object type: array objects: items: $ref: '#/components/schemas/PortObjectOverlaps' type: object type: array type: object CipherSuiteListListContainer: properties: items: $ref: '#/components/schemas/CipherSuiteList' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object RealmStatus: description: This object can be used to get SAML realm status. properties: id: description: A SAML Realm ID to which this status corresponds. type: string status: $ref: '#/components/schemas/ConnectorStatusBody' description: An object containing the exact status value plus a description for more details or troubleshooting suggestions. type: object type: description: Type of information. This value is always 'RealmStatus'. type: string type: object SIURLFeed: description: Object representing a user-specified third-party feed. properties: checksumURL: description: Checksum of the feed file on remote server. type: string description: description: Description of the Security Intelligence feed. type: string feedURL: description: URL representing the Security Intelligence feed location. type: string id: description: Unique identifier representing the Security Intelligence URL feed. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object listType: format: int32 type: integer metadata: $ref: '#/components/schemas/SIFeedMetadata' description: Object representing metadata attributes for the SIURLFeed object. type: object name: description: Name of the Security Intelligence URL Feed object. type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object subType: type: string type: description: Type must be SIURLFeed. type: string updateFrequency: description: Feed update interval in minutes. format: int32 type: integer version: description: Version number of the response object. type: string type: object VarDef: properties: empty: type: boolean literals: items: type: string type: array referenceObjects: items: $ref: '#/components/schemas/IReference' type: object type: array variables: items: type: string type: array type: object CountryObject: description: Represents a Country. properties: description: description: This field is deprecated and should not be used. type: string id: description: Identifier matching country from geolocation database. type: string iso2: description: ISO2 country code string. type: string iso3: description: ISO3 country code string. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for the country. type: object name: description: Name of the Country. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always Country. type: string version: description: Version number of the response object. type: string type: object ApplicationTagListContainer: properties: items: $ref: '#/components/schemas/ApplicationTag' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IServiceAccessRule: properties: action: enum: - ALLOW - DENY type: string geoSources: items: $ref: '#/components/schemas/IReference' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string sequenceNumber: format: int32 type: integer type: type: string type: object KeyChainObjectOverrideListContainer: properties: items: $ref: '#/components/schemas/KeyChainObjectOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ProtocolPortObject: description: A model representing protocol port object definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/PortMetadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Boolean indicating whether object values can be override. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object port: description: Port number for the object. type: string protocol: description: 'IANA protocol number or Ethertype. This is handled differently for Transport and Network layer protocols. Transport layer protocols are identified by the IANA protocol number. For example: • 6 — TCP • 17 — UDP Network layer protocols are identified by the decimal form of the IEEE Registration Authority Ethertype. For example: • 2048 — IP.' type: string type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object IVpnScepContentModel: properties: challengePassword: type: string enrollmentUrl: type: string fingerprint: type: string retryCount: type: string retryPeriodInMins: type: string type: object URLObjectListContainer: properties: items: $ref: '#/components/schemas/URLObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IUrlLiteral: properties: type: type: string url: type: string type: object INetworkBase: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object IPKIRevocationModel: properties: certRevocationListContent: $ref: '#/components/schemas/IPKICertRevocationListModel' type: object evaluationPriority: enum: - CRL - OCSP - NONE type: string ignoreRevocation: type: boolean onlineCertificateStatusProtocolContent: $ref: '#/components/schemas/IPKIOnlineCertificateStatusProtocolModel' type: object type: object IRecurrence: description: Object fragment that represents a recurrence interval. A recurrence interval specifies a duration that repeats on a weekly basis, during which the time range is effective. If recurrence interval is of type RANGE, the fragment represents a continuous duration of time that repeats every week. If recurrence interval is of type DAILY_INTERVAL, the fragment represents a period of time that repeats on selected days of week. properties: dailyEndTime: description: Represents the time (in ISO 8601 format) at which the time range stops being effective on selected days. This field must be used if recurrenceType is specified as DAILY_INTERVAL. type: string dailyStartTime: description: Represents the time (in ISO 8601 format) at which the time range starts being effective on selected days. This field must be used if recurrenceType is specified as DAILY_INTERVAL. type: string days: description: Represents the days of week on which the time range is effective. This field must be used if recurrenceType is specified as DAILY_INTERVAL. items: enum: - MON - TUE - WED - THU - FRI - SAT - SUN type: string type: array rangeEndDay: description: Represents the time (in ISO 8601 format) at which the time range stops being effective. This field must be used if recurrenceType is specified as RANGE. enum: - MON - TUE - WED - THU - FRI - SAT - SUN type: string rangeEndTime: description: Represents the day of week at which the time range stops being effective. This field must be used if recurrenceType is specified as RANGE. type: string rangeStartDay: description: Represents the day of week at which the time range starts being effective. This field must be used if recurrenceType is specified as RANGE. enum: - MON - TUE - WED - THU - FRI - SAT - SUN type: string rangeStartTime: description: Represents the time (in ISO 8601 format) at which the time range starts being effective. This field must be used if recurrenceType is specified as RANGE. type: string recurrenceType: description: Type of the recurrence interval. This value can be either DAILY_INTERVAL or RANGE. enum: - DAILY_INTERVAL - RANGE type: string required: - dailyEndTime - dailyStartTime - days - rangeEndDay - rangeEndTime - rangeStartDay - rangeStartTime - recurrenceType type: object AnyConnectCustomAttributeModel: description: AnyConnect Custom Attribute objects represent custom attribute used in configurations, typically for remote access VPN policies. They can contain custom attribute in AnyConnect. properties: attributeType: description: Type of AnyConnect custom attribute variable. type: string deferUpdate: $ref: '#/components/schemas/IAnyConnectDeferUpdateAttribute' description: Specifies the AnyConnect Defer Update Attribute. type: object description: description: User provided resource description. type: string dynamicSplitTunnel: $ref: '#/components/schemas/IAnyConnectDynamicSplitTunnelAttribute' description: Specifies the AnyConnect Dynamic Split Tunnel Attribute. type: object id: description: Unique identifier representing the AnyConnect Package object. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for the AnyConnect Package. type: object name: description: User provided resource name. type: string overridable: type: boolean overrideTargetId: type: string overrides: $ref: '#/components/schemas/IOverride' type: object perAppVpnBase64EncodedValue: description: Value of AnyConnect Per App Vpn Attribute. type: string type: description: 'Type associated with resource: AnyConnectPackage.' type: string userDefinedAttribute: $ref: '#/components/schemas/IAnyConnectUserDefinedAttribute' description: Specifies the AnyConnect User Defined Attribute. type: object version: type: string required: - attributeType type: object IMetadataUser: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object IRealm: properties: activeAuthSessionTimeout: format: int32 type: integer adJoinPassword: type: string adJoinUsername: type: string adPrimaryDomain: type: string authSessionTimeout: format: int32 type: integer baseDn: type: string description: type: string dirPassword: type: string dirUsername: type: string directoryConfigurations: items: $ref: '#/components/schemas/IDirectoryConfiguration' type: object type: array enabled: type: boolean excludedGroups: items: type: string type: array excludedUsers: items: type: string type: array failedAuthSessionTimeout: format: int32 type: integer groupAttribute: type: string groupDn: type: string guestSessionTimeout: format: int32 type: integer id: type: string includedGroups: items: type: string type: array includedUsers: items: type: string type: array links: $ref: '#/components/schemas/ILinks' type: object name: type: string proxy: $ref: '#/components/schemas/IProxy' type: object realmId: format: int32 type: integer realmType: enum: - AD - LDAP - LOCAL - DISCOVERED - SPECIAL - AZURE_AD - SAML type: string tsAgentSessionTimeout: format: int32 type: integer type: type: string updateHour: format: int32 type: integer updateInterval: format: int32 type: integer version: type: string type: object IGroupPolicySplitTunnelSettingsModel: description: Model representing the Split Tunnel Policy Settings properties: ipv4SplitTunnelPolicy: enum: - TUNNEL_ALL - TUNNEL_SPECIFIED - EXCLUDE_SPECIFIED_OVER_TUNNEL type: string ipv6SplitTunnelPolicy: enum: - TUNNEL_ALL - TUNNEL_SPECIFIED - EXCLUDE_SPECIFIED_OVER_TUNNEL type: string splitDNSDomainList: description: Optional. Specifies List of domain names applicable for splitDNS configuration type: string splitDNSRequestPolicy: enum: - USE_SPLIT_TUNNEL_SETTING - TUNNEL_ALL - TUNNEL_SPECIFIED_DOMAINS type: string splitTunnelACL: $ref: '#/components/schemas/IReference' description: If Split tunnel option is selected as TUNNEL_SPECIFIED or EXCLUDE_SPECIFIED_OVER_TUNNEL, splitTunnelACL is Mandatory. Standard access list or Extended Access List specifies matching traffic type: object type: object ServiceAccessObjectOverrideListContainer: properties: items: $ref: '#/components/schemas/ServiceAccessObjectOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object TimeZoneObject: description: Object representing a time zone object. properties: description: description: 'User provided resource description. ' type: string dstDateRange: $ref: '#/components/schemas/ITimeZoneDateRangeFragment' description: Object representing the daylight saving configuration by date range. Either dstDateRange or dstDayRecurrence field must be configured to enable daylight saving for the object. type: object dstDayRecurrence: $ref: '#/components/schemas/ITimeZoneDayRecurrenceFragment' description: Object representing the daylight saving configuration by day-based recurrence. Either dstDateRange or dstDayRecurrence field must be configured to enable daylight saving. type: object id: description: Unique identifier representing response object. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of the response object. type: object name: description: User assigned resource name. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object timeZone: description: Read-only field containing description of the specified global time zone (timeZoneId). type: string timeZoneId: description: Unique identifier of the global time zone from the IANA time zone (tz) database. type: string type: description: Type of the response object. This value is always TimeZoneObject. type: string version: description: Version number of the response object. type: string type: object RealmUserGroupMetadata: description: An object representing the metadata of the RealmUserGroup. properties: domain: $ref: '#/components/schemas/Domain' type: object hasUnresolvedReferences: description: Field represents whether this `Realm` has unresolved references. type: boolean isLocked: type: boolean lastSynced: description: Field represents timestamp of the last sync for the RealmUserGroup. format: int32 type: integer lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object timestamp: format: int32 type: integer type: object UrlOverride: description: A model representing URL object override definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Always returns false for overrides. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on device or domain. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object HostOverrideListContainer: properties: items: $ref: '#/components/schemas/HostOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object RealmUserGroup: description: Defines Identity RealmUserGroup Object. properties: id: description: Unique Identifier of the group. type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/RealmUserGroupMetadata' description: Metadata object of the RealmUserGroup. type: object name: description: Name of the RealmUserGroup. type: string realm: $ref: '#/components/schemas/IRealm' description: Realm object for the group. type: object type: description: Value is 'RealmUserGroup'. Read-only fixed value. type: string type: object IApplicationTag: description: Represents an ApplicationTag. properties: description: description: Application tag resource description. type: string id: description: Unique identifier for the application tag. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the application tag. type: object name: description: Name of the application tag. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always ApplicationTag. type: string version: description: Version number of the response object. type: string type: object IExpandedCommunityListEntry: properties: action: enum: - PERMIT - DENY type: string regularExpression: type: string sequence: format: int32 type: integer type: type: string required: - action - regularExpression - sequence type: object IPv6AddressPoolOverride: description: A model representing IPv6AddressPoolOverride definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Always returns false of overrides. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object ExtendedCommunityListOverrideListContainer: properties: items: $ref: '#/components/schemas/ExtendedCommunityListOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ReadOnly: description: Defines the read only conditions if the referenced resource is read only. properties: reason: description: Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain). enum: - RBAC - SYSTEM - DOMAIN type: string state: description: True if this resource us read only and false otherwise. type: boolean type: object IKEv2IPsecProposalListContainer: properties: items: $ref: '#/components/schemas/IKEv2IPsecProposal' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object UmbrellaProtectionPolicyListContainer: properties: items: $ref: '#/components/schemas/UmbrellaProtectionPolicy' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object NetworkOverlapsContainer: properties: literals: items: $ref: '#/components/schemas/NetworkLiteralOverlaps' type: object type: array objects: items: $ref: '#/components/schemas/NetworkObjectOverlaps' type: object type: array type: object Snort3IPSRulesObjectListContainer: properties: items: $ref: '#/components/schemas/Snort3IPSRulesObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object Metadata: description: Defines read only details about the object - whether it is system defined, last user who modified the object etc. properties: domain: $ref: '#/components/schemas/Domain' description: Defines the domains this instance belongs to (if applicable). type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' description: The last user who modified this instance. type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' description: Details regarding the read only status of this instance type: object timestamp: description: The last updated timestamp. format: int32 type: integer type: object PortObjectGroup: description: A model representing port group definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/PortMetadata' description: Object representing metadata properties of response object. type: object name: description: User-specified name of the policy assignment. type: string objects: description: Represents port objects in group. items: $ref: '#/components/schemas/IPortObject' type: object type: array overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object DistinguishedNameGroup: description: Represents the group of distinguished name objects. properties: description: type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: description: User chosen resource name. type: string objects: items: $ref: '#/components/schemas/IDistinguishedName' type: object type: array type: description: Type of the response object. This value is always 'DistinguishedNameGroup'. type: string version: type: string type: object IHybridResourceAddressesContainer: properties: destinationAddresses: $ref: '#/components/schemas/INetworkObjectsContainer' type: object protocolPorts: $ref: '#/components/schemas/IPortObjectsContainer' type: object type: object ExpandedCommunityList: description: Represents a ExpandedCommunityList. properties: entries: description: List of standard or expanded community entries that this object holds items: $ref: '#/components/schemas/IExpandedCommunityListEntry' type: object type: array id: description: Unique identifier for the expanded community list. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Metadata associated with this object. type: object name: description: Specifies a unique name assigned to this list type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always ExpandedCommunityList. type: string version: description: Version number of the response object. type: string required: - name type: object Links: properties: parent: type: string self: type: string type: object SpSettings: properties: acsUrl: type: string baseUrl: $ref: '#/components/schemas/ReferenceObject' type: object baseUrlId: type: string certificate: $ref: '#/components/schemas/ReferenceObject' type: object certificateId: type: string entityId: type: string type: object IRadiusServers: description: Radius servers are used to authenticate users logging in through Remote Access VPN connections. properties: accountingPort: format: int32 type: integer authenticationPort: format: int32 type: integer enableMessageAuthenticator: type: boolean host: description: IP Address or the FQDN Name of the Radius Server type: string interface: $ref: '#/components/schemas/IReference' description: Interface to connect the Radius Server. type: object redirectACL: $ref: '#/components/schemas/IReference' description: Acl that needed to be applied for dynamic authorization. type: object secretKey: type: string timeout: description: Time in seconds that FTD waits for Radius Server's response. format: int32 type: integer useRoutingToSelectInterface: description: Specify the routing table or the interface to be used to connect the radius server type: boolean required: - authenticationPort - host - secretKey type: object PrivateResourceGroupListContainer: properties: items: $ref: '#/components/schemas/PrivateResourceGroup' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DynamicObject: description: The details about the Dynamic Object. properties: agentId: type: string description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/DynamicObjectMetadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string objectType: description: Type of dynamic object mappings. Currently we support only 'IP'. type: string topicName: type: string type: description: Type of the Dynamic objects; this value is always DynamicObject. type: string version: type: string type: object UrlOverrideListContainer: properties: items: $ref: '#/components/schemas/UrlOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object VlanOverride: description: A model representing vlan tag override definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Always returns false for overrides. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object KeyChainObjectOverride: properties: description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object ExternalCACertificateListContainer: properties: items: $ref: '#/components/schemas/ExternalCACertificate' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DynamicObjectMappings: description: The details about the Dynamic Object Mappings. properties: description: type: string id: description: Unique identifier representing Dynamic Object. type: string links: $ref: '#/components/schemas/Links' type: object mappings: description: List of Hostname or Network which will be mapped or removed from Dynamic Object items: type: string type: array metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string type: description: Type of the Dynamic objects Mappings; this value is always DynamicObjectMappings. type: string version: type: string type: object MacAddressPoolOverride: properties: description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object AsPathList: description: To apply autonomous system path filters to both inbound and outbound BGP paths. properties: entries: description: List of regular expression entries that this object holds. items: $ref: '#/components/schemas/IAsPathListEntry' type: object type: array id: description: Unique identifier (UUID) for the AsPathList. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for AsPathList. type: object name: description: The unique name for the AsPathList object. format: int32 type: integer overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type of AsPathList object. type: string version: description: Version number of the response object. type: string type: object SSOServerOverride: description: A model representing SSOServerOverride object definition. properties: description: description: User provided description. type: string id: description: Unique UUID representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Always returns false for overrides. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object SecureClientCustomizationModel: description: Secure Client Customization functionality provides a way to modify and customize certain aspects of the Secure Client on the endpoints. Those customizations can be pushed to the endpoints via FTD. Secure Client Customization object is used to upload and maintain the cutsomization files and setting in FMC. Customization objects can then be added to the Remote Access VPN Configuration to push it to the FTD. properties: customizationType: description: Customization Type enum: - LANGUAGE_LOCALIZATION - IMAGE - SCRIPT - BINARY - CUSTOMIZED_INSTALLER_TRANSFORM - LOCALIZED_INSTALLER_TRANSFORM type: string description: description: User provided resource description. type: string fileName: description: Name of the customization file. type: string files: items: $ref: '#/components/schemas/IFileWrapper' type: object type: array filesMap: $ref: '#/components/schemas/LLFilesMap' type: object id: description: Unique identifier representing this resource. type: string language: description: Language code for the Language localization type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User provided resource name. type: string operatingSystem: description: Operating System which is applicable for the selected customization file enum: - WINDOWS - LINUX - MAC type: string scriptType: description: Specifies when to execute the scipt enum: - ON_CONNECT - ON_DISCONNECT type: string type: description: 'Type associated with resource: SecureClientCustomizationModel.' type: string version: type: string required: - customizationType - fileName type: object SINetworkListListContainer: properties: items: $ref: '#/components/schemas/SINetworkList' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ServiceAccessObjectListContainer: properties: items: $ref: '#/components/schemas/ServiceAccessObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DNSServerGroupObjectListContainer: properties: items: $ref: '#/components/schemas/DNSServerGroupObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ApplicationRiskListContainer: properties: items: $ref: '#/components/schemas/ApplicationRisk' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IStandardCommunityListEntry: properties: action: enum: - PERMIT - DENY type: string communities: type: string internet: type: boolean noAdvertise: type: boolean noExport: type: boolean sequence: format: int32 type: integer type: type: string required: - action - communities - sequence type: object NetworkLiteralOverlaps: properties: overlapType: enum: - PARTIAL - FULL type: string overlappingLiterals: items: $ref: '#/components/schemas/NetworkLiteralOverlaps' type: object type: array overlappingObjects: items: $ref: '#/components/schemas/NetworkObjectOverlaps' type: object type: array type: type: string value: type: string type: object ICMPV4ObjectListContainer: properties: items: $ref: '#/components/schemas/ICMPV4Object' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object SLAMonitorObjectModel: properties: dataSize: format: int32 type: integer description: type: string frequency: format: int32 type: integer id: type: string interfaceNames: items: type: string type: array interfaceObjects: items: $ref: '#/components/schemas/IInterfaceObjectModel' type: object type: array links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object monitorAddress: type: string name: type: string noOfPackets: format: int32 type: integer overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object slaId: format: int32 type: integer threshold: format: int32 type: integer timeout: format: int32 type: integer tos: format: int32 type: integer type: type: string version: type: string required: - interfaceObjects - monitorAddress - slaId type: object IGroupPolicyAnyConnectSettingsModel: description: Model representing the Configurations for AnyConnect Client. properties: clientModules: description: Optional. Represents specified Anyconnect modules to be downloaded when VPN user downloads Anyconnect Client items: $ref: '#/components/schemas/IGroupPolicyClientModulesModel' type: object type: array connectionSettings: $ref: '#/components/schemas/IGroupPolicyConnectionSettingsModel' description: Optional. Configures the connection parameters to be applied on the VPN connectivity. type: object customAttributes: items: $ref: '#/components/schemas/IGroupPolicyCustomAttributesModel' type: object type: array managementProfile: $ref: '#/components/schemas/IReference' description: Optional. Represents VPN Management Profile Object whose filetype is ANYCONNECT_VPN_PROFILE type: object sslSettings: $ref: '#/components/schemas/IGroupPolicySSLSettingsModel' description: Optional. Configures SSL Settings parameters to be used when connecting to the Client. type: object vpnClientProfile: $ref: '#/components/schemas/IReference' description: Optional. Represents VPN Client Profile Object whose filetype is ANYCONNECT_VPN_PROFILE type: object type: object Object: type: object ICMPV4ObjectOverride: properties: description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object NetworkGroupOverrideListContainer: properties: items: $ref: '#/components/schemas/NetworkGroupOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object AnyProtocolPortObject: description: A model representing Any portocol port object definition. properties: description: description: 'User provided resource description. ' type: string id: description: Unique identifier. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object metadata: $ref: '#/components/schemas/PortMetadata' description: Object representing metadata properties. type: object name: description: User chosen resource name. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: Represents an alternate value for an object on a device or domain. type: object type: description: 'Type associated with resource: AnyProtocolPortObject.' type: string version: description: Version number of the response object. type: string type: object IContinentModel: description: Represents a Continent. properties: code: description: This field is deprecated and should not be used. format: int32 type: integer countries: description: List of objects representing countries. items: $ref: '#/components/schemas/ICountryModel' type: object type: array description: description: This field is deprecated and should not be used. type: string id: description: Identifier matching contient from geolocation database. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the continent. type: object name: description: Name of the Continent. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always Continent. type: string version: description: Version number of the response object. type: string type: object Ikev2PolicyObject: properties: description: type: string diffieHellmanGroups: items: format: int32 type: integer type: array encryptionAlgorithms: items: type: string type: array id: type: string integrityAlgorithms: items: type: string type: array lifetimeInSeconds: format: int32 type: integer links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string prfIntegrityAlgorithms: items: type: string type: array priority: format: int32 type: integer type: type: string version: type: string type: object ITimeZoneDayRecurrenceFragment: description: Object fragment to configure the daylight saving by day recurrence. properties: endDayOfWeek: description: Day of the week on which the daylight saving will end. enum: - MON - TUE - WED - THU - FRI - SAT - SUN type: string endMonth: description: Month of the year on which the daylight saving will end. enum: - JAN - FEB - MAR - APR - MAY - JUN - JUL - AUG - SEP - OCT - NOV - DEC type: string endTime: description: Time of the day (in 24-hour HH:mm format) at which the daylight saving will end. type: string endWeek: description: An ordinal number, from 1-52, representing the week on which the daylight saving will end. enum: - FIRST - SECOND - THIRD - FOURTH - LAST type: string offset: description: Number (in minutes) representing the offset from specified time zone. Offset value must be between 1-1440. format: int32 type: integer startDayOfWeek: description: Day of the week on which the daylight saving will start. enum: - MON - TUE - WED - THU - FRI - SAT - SUN type: string startMonth: description: Month of the year on which the daylight saving will start. enum: - JAN - FEB - MAR - APR - MAY - JUN - JUL - AUG - SEP - OCT - NOV - DEC type: string startTime: description: Time of the day (in 24-hour HH:mm format) at which the daylight saving will start. type: string startWeek: description: An ordinal number, from 1-52, representing the week on which daylight saving will start. enum: - FIRST - SECOND - THIRD - FOURTH - LAST type: string type: object StandardACL: description: An access control list (ACL) consists of one or more access control entries (ACE) that collectively define the network traffic profile. Standard Access Control List identifies traffic based on destination address only. Supports IPv4 only. properties: description: description: User-provided object description. type: string entries: description: List of networks entries that this object holds. items: $ref: '#/components/schemas/IStandardACLEntry' type: object type: array id: description: Unique identifier (UUID) for the Standard Access Control List. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for Standard Access Control List. type: object name: description: The unique name for the Standard Access Control List object. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type of Standard Access Control List object. type: string version: description: Version number of the response object. type: string required: - entries - name type: object ISESecurityGroupTagListContainer: properties: items: $ref: '#/components/schemas/ISESecurityGroupTag' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object NetworkObjectListContainer: properties: items: $ref: '#/components/schemas/NetworkObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ICMPV4Object: description: An object defining a ICMPv4 Port object definition. properties: code: description: ICMP code number. format: int32 type: integer description: description: User provided resource description. type: string icmpType: description: ICMP type number. type: string id: description: Unique identifier representing response object. type: string links: $ref: '#/components/schemas/Links' description: Object containing related links. type: object metadata: $ref: '#/components/schemas/PortMetadata' description: Object representing metadata properties of response object. type: object name: description: User assigned resource name. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrideTargetId: description: Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain). type: string overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: 'Type associated with resource: ICMPV4Object.' type: string version: description: Version number of the response object. type: string type: object IRuleAction: description: Object representing the rule action specified for an intrusion policy. properties: default: description: 'Default state of the rule for the specified intrusion policy. One of: DROP | BLOCK | ALERT | DISABLE | DEFAULT | PASS | REJECT | REACT | REWRITE' enum: - DROP - BLOCK - ALERT - DISABLE - DEFAULT - PASS - REJECT - REACT - REWRITE type: string override: description: 'Override state of the rule for the specified intrusion policy. One of: DROP | BLOCK | ALERT | DISABLE | DEFAULT | PASS | REJECT | REACT | REWRITE' enum: - DROP - BLOCK - ALERT - DISABLE - DEFAULT - PASS - REJECT - REACT - REWRITE type: string policy: $ref: '#/components/schemas/IIntrusionPolicyModel' description: Object representing the intrusion policy. type: object recommended: enum: - DROP - BLOCK - ALERT - DISABLE - DEFAULT - PASS - REJECT - REACT - REWRITE type: string type: object StandardCommunityListListContainer: properties: items: $ref: '#/components/schemas/StandardCommunityList' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object NetworkAddressOverrides: properties: description: type: string id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string networkType: type: string overridable: type: boolean overrideTargetId: type: string overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string value: type: string version: type: string type: object ExtendedAccessListModelListContainer: properties: items: $ref: '#/components/schemas/ExtendedAccessListModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IBasePortLiteral: properties: protocol: type: string type: type: string type: object VlanTagGroupListContainer: properties: items: $ref: '#/components/schemas/VlanTagGroup' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IBFDTemplateAuthentication: properties: authKey: type: string authKeyId: format: int32 type: integer authType: enum: - MD5 - METICULOUSMD5 - METICULOUSSHA1 - SHA1 - NONE type: string pwdEncryption: enum: - UN_ENCRYPTED - ENCRYPTED - NONE type: string type: object CommunityListListContainer: properties: items: $ref: '#/components/schemas/CommunityList' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object UrlGroupOverride: description: A model representing URL group override definition. properties: description: description: User provided description. type: string id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string overridable: description: Always returns false for overrides. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type associated with resource. type: string version: description: Version number of the response object. type: string type: object Snort3IPSRuleMetadata: properties: defaultSetBy: items: $ref: '#/components/schemas/ISnort3DefaultSetBy' type: object type: array domain: $ref: '#/components/schemas/Domain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object replaceRule: type: boolean timestamp: format: int32 type: integer type: object IAnyConnectDeferUpdateAttribute: properties: defaultAction: enum: - DEFER - UPDATE type: string minimumAnyConnectVersion: type: string promptDismissTimeout: format: int32 type: integer promptType: enum: - SHOW_UNTIL_USER_ACTION - SHOW_UNTIL_TIMEOUT - NO_PROMPT_AUTO_ACTION type: string type: object INetworkAddressLiteral: properties: type: type: string value: type: string type: object ExternalCACertificateGroupListContainer: properties: items: $ref: '#/components/schemas/ExternalCACertificateGroup' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IDHCPIPv6DomainName: properties: importFromInternalServer: type: boolean names: items: type: string type: array type: object Ikev1PolicyObjectListContainer: properties: items: $ref: '#/components/schemas/Ikev1PolicyObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IFTDInterface: properties: description: type: string id: type: string ifname: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object PolicyListListContainer: properties: items: $ref: '#/components/schemas/PolicyList' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DownloadAzureADUsersAndGroups: description: Download the users and groups for specific Azure AD realm. properties: {} type: object IKeyObject: properties: acceptLifeTime: $ref: '#/components/schemas/ILifeTime' type: object authAlgorithm: type: string authString: $ref: '#/components/schemas/IAuthTypeAndString' type: object keyId: format: int32 type: integer sendLifeTime: $ref: '#/components/schemas/ILifeTime' type: object type: object RealmUserGroupListContainer: properties: items: $ref: '#/components/schemas/RealmUserGroup' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ILifeTime: properties: endLifeTimeValue: type: string endLifetimeType: enum: - INFINITE - DURATION - DATETIME type: string startLifeTimeValue: type: string timeZone: type: string type: object ContinentObject: description: Represents a Continent. properties: code: description: This field is deprecated and should not be used. format: int32 type: integer countries: description: List of objects representing countries. items: $ref: '#/components/schemas/ICountryModel' type: object type: array description: description: This field is deprecated and should not be used. type: string id: description: Identifier matching continent from geolocation database. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for the continent. type: object name: description: Name of the Continent. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always Continent. type: string version: description: Version number of the response object. type: string type: object IApplicationProductivity: description: Represents an ApplicationProductivity. properties: description: description: Application productivity resource description. type: string id: description: Unique identifier for the application productivity. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the application productivity. type: object name: description: Name of the application productivity. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always ApplicationProductivity. type: string version: description: Version number of the response object. type: string type: object GroupPolicyModel: description: Model representing the Group Policy configuration for RA VPN. properties: advancedSettings: $ref: '#/components/schemas/IGroupPolicyAdvancedSettingsModel' type: object anyConnectSettings: $ref: '#/components/schemas/IGroupPolicyAnyConnectSettingsModel' type: object description: description: Represents the Group Policy configuration for RA VPN. It is a collation of Attribute and value pairs that determines parameters for the functionality of RA VPN type: string enableIPsecIKEv2Protocol: description: Enable IPSec IKEv2 type of Remote Access VPN tunnel that can be used when applying this group policy type: boolean enableSSLProtocol: description: Enable SSL type of Remote Access VPN tunnel that can be used when applying this group policy type: boolean generalSettings: $ref: '#/components/schemas/IGroupPolicyGeneralSettingsModel' type: object id: description: Specifies Unique identifier (UUID) representing the Group Policy object type: string links: $ref: '#/components/schemas/Links' description: Specifies links to this object. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for the Group Policy type: object name: description: ' Identifies the Group Policy Object so that can be referred to other configurations' type: string type: description: Specifies unique type of the Group Policy. type: string version: type: string type: object ISnort3DefaultSetBy: description: Object representing on how default action is set in a policy. properties: action: description: Based on how default action is set in a policy for a rule. type: string id: description: The unique UUID of the object. type: string name: description: Name of the action. type: string type: description: Type of the object. type: string type: object RangeObjectListContainer: properties: items: $ref: '#/components/schemas/RangeObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object VlanOverrideListContainer: properties: items: $ref: '#/components/schemas/VlanOverride' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object InternalCertificateListContainer: properties: items: $ref: '#/components/schemas/InternalCertificate' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object SecureClientCustomizationModelListContainer: properties: items: $ref: '#/components/schemas/SecureClientCustomizationModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IPv4PrefixList: description: Prefix lists are used in route maps and route filtering operations and can be used as an alternative to access lists in many Border Gateway Protocol (BGP) route filtering commands. properties: description: description: User-provided object description. type: string entries: description: List of IP prefix entries that this object holds. items: $ref: '#/components/schemas/IIPvPrefixListEntry' type: object type: array id: description: Unique identifier (UUID) for the IPv4PrefixList. type: string links: $ref: '#/components/schemas/Links' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for IPv4PrefixList. type: object name: description: The unique name for the IPv4PrefixList object. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object. type: object type: description: Type of IPv4PrefixList object. type: string version: description: Version number of the response object. type: string required: - name type: object CustomSIIPListDownload: description: Object representing a CustomSIIPListDownload object. properties: attrib: description: Name of the downloaded file. type: string description: description: Description of the CustomSIIPListDownload object. type: string id: description: Unique identifier representing the CustomSIIPListDownload. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object name: description: Name of the CustomSIIPListDownload object. type: string path: description: Path of the file to download on the server. type: string type: description: Type must be CustomSIIPListDownload. type: string version: description: Version number of the response object. type: string type: object SecurityGroupTagListContainer: properties: items: $ref: '#/components/schemas/SecurityGroupTag' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object InterfaceObjectListContainer: properties: items: $ref: '#/components/schemas/InterfaceObject' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object parameters: limit: description: Number of items to return. in: query name: limit required: false schema: format: int32 type: integer expanded: description: If set to true, the GET response displays a list of objects with additional attributes. in: query name: expanded required: false schema: type: boolean offset: description: Index of first item to return. in: query name: offset required: false schema: format: int32 type: integer domainUUID: description: Domain UUID in: path name: domainUUID required: true schema: type: string securitySchemes: bearerAuth: bearerFormat: JWT scheme: bearer type: http x-refined-from: - cdfmc-openapi.yaml - cisco-secure-firewall-cdfmc-openapi.yml