topic Re: FirePower Rest API response for FTD cluster in Network Security

FirePower Rest API response for FTD cluster

meidanmeshulam — Wed, 03 Mar 2021 07:10:37 GMT

Hi all

In my company, we're fetching data from CISCO FirePower FMC via Rest API.
Lets say this FMC is managing 2 FTDs working in cluster mode and I'm using these two API calls: "/api/fmc_config/v1/domain/{domainUUID}/deviceclusters/ftddevicecluster"
"/api/fmc_config/v1/domain/{domainUUID}/deviceclusters/ftddevicecluster/{objectId}"

What does the response for these calls look like ?
Can anyone provide an example ?

Many Thanks Champs !

Re: FirePower Rest API response for FTD cluster

Madhuri Dewangan — Fri, 05 Mar 2021 16:54:47 GMT

Hi,

The sample response for the all the available API endpoints is available at https://<FMC-IP>/api/api-explorer/

Sample Response (if the request return 200 as response code) will be :

"/api/fmc_config/v1/domain/{domainUUID}/deviceclusters/ftddevicecluster"

{
    "links": {
        "self": "/fmc_config/v1/domain/DomainUUID/deviceclusters/ftddevicecluster?offset=0&limit=1&expanded=true"
    },
    "items": [
        {
            "id": "<container_uuid>",
            "links": {
                "self": "/fmc_config/v1/domain/DomainUUID/deviceclusters/ftddevicecluster/<container_uuid>"
            },
            "name": "<cluster_name>"
        },
        {
            "id": "<container_uuid>",
            "links": {
                "self": "/fmc_config/v1/domain/DomainUUID/deviceclusters/ftddevicecluster/<container_uuid>"
            },
            "name": "<cluster_name>"
        },
        {
            "id": "<container_uuid>",
            "links": {
                "self": "/fmc_config/v1/domain/DomainUUID/deviceclusters/ftddevicecluster/<container_uuid>"
            },
            "name": "<cluster_name>"
        }
    ],
    "paging": {
        "offset": 0,
        "limit": 3,
        "count": 3,
        "pages": 1
    }
}

For "/api/fmc_config/v1/domain/{domainUUID}/deviceclusters/ftddevicecluster/{objectId}"

{
    "id": "35874370-9957-11e8-af35-2038dcb5d0fa",
    "type": "DeviceCluster",
    "links": {
        "self": "/fmc_config/v1/domain/DomainUUID/deviceclusters/ftddevicecluster?offset=0&limit=1&expanded=true"
    },
    "name": "<cluster_name>",
    "masterDevice": {
        "id": "<master_device_UUID>",
        "type": "Device",
        "keepLocalEvents": false
    },
    "slaveDevices": [
        {
            "id": "<slave1_device_UUID>",
            "type": "Device",
            "keepLocalEvents": false
        },
        {
            "id": "<slave2_device_UUID>",
            "type": "Device",
            "keepLocalEvents": false
        },
        {
            "id": "<slave3_device_UUID>",
            "type": "Device",
            "keepLocalEvents": false
        }
    ],
    "metadata": {
        "clusterDeviceGroup": {
            "id": "<device_group_id>",
            "type": "DeviceGroup",
            "name": "<device_group_name>"
        },
        "lastUser": {
            "name": "admin",
            "type": "User"
        },
        "domain": {
            "id": "<domain_uuid>",
            "type": "Domain"
        }
    }
}

Re: FirePower Rest API response for FTD cluster

meidanmeshulam — Sun, 07 Mar 2021 06:15:13 GMT

@Madhuri Dewangan

This is amazing : ]
Thanks champ

Re: FirePower Rest API response for FTD cluster

meidanmeshulam — Sun, 07 Mar 2021 06:43:16 GMT

@Madhuri Dewangan Can you tell me what chassis is this ? What FirePower version are we looking at ?

Thanks !

Re: FirePower Rest API response for FTD cluster

Madhuri Dewangan — Sun, 07 Mar 2021 07:24:44 GMT

@meidanmeshulam this is a sample api response which you get in api explorer against the requested api endpoint. I gave this output from my lab virtual FMC which is running version 6.6.1

Re: FirePower Rest API response for FTD cluster

meidanmeshulam — Tue, 16 Mar 2021 14:46:16 GMT

@Madhuri Dewangan
I thought cluster is not supported for FTDv.

You're saying that you have a lab with virtual devices and you have clustering capabilities ? can you please explain ?

Re: FirePower Rest API response for FTD cluster

Madhuri Dewangan — Tue, 16 Mar 2021 15:21:43 GMT

Yes Cluster is not supported in Virtual FTD. Since the question was around how the response for the mentioned call will look like. I had shared the response format from api explorer, this is not an actual response.