DCI

The following are the DCI REST APIs:

Status

The following table details the API Response code, status and, the HTTPS methods.

Status Code
Status
API's HTTPS Method or
HTTPS Method

200

OK

GET

202

Accepted

POST

PUT

DELETE

400

Bad Request

GET

POST

PUT

DELETE

401

Unauthorized

GET

POST

PUT

DELETE

403

Forbidden

GET

POST

PUT

DELETE

404

Not Found

GET

POST

PUT

DELETE

405

Method Not Allowed

GET

POST

PUT

DELETE

500

Internal Server Error

GET

POST

PUT

DELETE

Get Fabric Automation DCI Settings

Resource Name

/settings/dci

Description

Get Fabric Automation DCI settings

https Method

GET

URL

https://dcnm-ip/rest/settings/dci

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

settings

O

Return DCI settings

Update Fabric Automation DCI Settings

Resource Name

/settings/dci

Description

Update Fabric Automation DCI settings

https Method

PUT

URL

https://dcnm-ip/rest/settings/dci

Parameter

Parameter
Type
Description

settings

S

Update the DCI settings.

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

 

 

List DCI pairs

Resource Name

/auto-config/dci/paired-devices

Description

List all the DCI pairs.

https Method

GET

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

dci-pairings

S

DCI pairs

Create DCI Pairs

Resource Name

/auto-config/dci/paired-devices

Description

Create DCI pairing.

https Method

POST

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices

Parameter

Parameter
Type
Description

dci-pairing

O

DCI pairing

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

 

 

Get DCI Pairs with Node Id

Resource Name

/auto-config/dci/paired-devices/device/{node-id}

Description

Get the Edge Router with the paired border leaf for a given node ID, or of type “BL-DCI”, or type “Hub PE” without peering.

https Method

GET

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices/device/{node-id}

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

dci-pairing

O

DCI pairing

Update DCI Pairs with Node ID

Resource Name

/auto-config/dci/paired-devices/device/{node-id}

Description

Update the DCI pairing for the type "BL-DCI" or "BL" without peering

https Method

PUT

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices/device/{node-id}

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

dci-pairing

O

DCI pairing

Delete DCI Pairs with Node ID

Resource Name

/auto-config/dci/paired-devices/device/{node-id}

Description

Delete the DCI pairing for the type "BL-DCI" or "BL" without peering

https Method

DELETE

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices/device/{node-id}

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

 

 

Get DCI Pairs with Node ID and Peer ID

Resource Name

/auto-config/dci/paired-devices/device/{node-id}/peer/{peer-node-id}

Description

Get the DCI pairing for a given node-id and peer-id

https Method

GET

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices/device/{node-id}/peer/{peer-node-id}

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

dci-pairing

O

DCI pairing

Update DCI Pairs with Node ID and Peer ID

Resource Name

/auto-config/dci/paired-devices/device/{node-id}/peer/{peer-node-id}

Description

Update the DCI pairing for a given node-id and peer-id.

https Method

PUT

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices/device/{node-id}/peer/{peer-node-id}

Parameter

Parameter
Type
Description

dci-pairing

O

DCI Pairing

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

settings

O

Return DCI settings

Delete DCI Pairs with Node ID and Peer ID

Resource Name

/auto-config/dci/paired-devices/device/{node-id}/peer/{peer-node-id}

Description

Delete the DCI pairing for a given node ID and peer ID

https Method

DELETE

URL

https://dcnm-ip/rest/auto-config/dci/paired-devices/device/{node-id}/peer/{peer-node-id}

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

 

 

Create Partition with DCI Option

Resource Name

/auto-config/organizations/{organization-name}/partitions

Description

Create the partition with DCI ID and enable DCI extension.

https Method

POST

URL

https://dcnm-ip/rest/auto-config/organizations/{organization-name}/partitions

Parameter

Parameter
Type
Description

partition

O

Partition object

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

 

 

Update Partition with DCI ID

Resource Name

/auto-config/organizations/{organization-name}/partitions/{partition-name}

Description

Update the partition with DCI ID.

https Method

PUT

URL

https://dcnm-ip/rest/auto-config/organizations/{organization-name}/partitions/{partition-name}

Parameter

Parameter
Type
Description

partition

O

Partition object

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

 

 

Update Partition to Disable DCI Extension

Resource Name

/auto-config/organizations/{organization-name}/partitions/{partition-name}

Description

Update the partition to disable DCI extension.

https Method

PUT

URL

https://dcnm-ip/rest/auto-config/organizations/{organization-name}/partitions/{partition-name}

Parameter

Parameter
Type
Description

partition

O

Partition object

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

 

 

Update Partition to Enable DCI Extension

Resource Name

/auto-config/organizations/{organization-name}/partitions/{partition-name}

Description

Update the partition to enable DCI extension.

https Method

PUT

URL

https://dcnm-ip/rest/auto-config/organizations/{organization-name}/partitions/{partition-name}

Parameter

Parameter
Type
Description

partition

O

Partition object

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

 

 

List All Extended Partitions

Resource Name

/auto-config/dci/extended-partitions

Description

List all the extended partitions.

https Method

GET

URL

https://dcnm-ip/rest/auto-config/dci/extended-partitions

https://dcnm-ip/rest/auto-config/dci/extended-partitions?detail=true

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

extended-partition

O

Extended partition

List All Extended Partitions with a VRF

Resource Name

/auto-config/dci/extended-partitions/vrfs/{vrf-name}

Description

List all the extended partitions with a VRF.

https Method

GET

URL

https://dcnm-ip/rest/auto-config/dci/extended-partitions/vrfs/{vrf-name}

https://dcnm-ip/rest/auto-config/dci/extended-partitions/vrfs/{vrf-name}?detail=true

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

extended-partition

O

Extended partition

List all Extended Partitions in an Organization

Resource Name

/auto-config/dci/extended-partitions/organizations/{organization-name}

Description

List all the extended partitions in a organization.

https Method

GET

URL

https://dcnm-ip/rest/auto-config/dci/extended-partitions/organizations/{organization-name}

https://dcnm-ip/rest/auto-config/dci/extended-partitions/organizations/{organization-name}?detail=true

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

extended-partition

O

Extended partition

Get Extended Partition

Resource Name

/auto-config/dci/extended-partitions/organizations/{organization-name}/partitions/{partition-name}

Description

Get extended partition

https Method

GET

URL

https://dcnm-ip/rest/auto-config/dci/extended-partitions/organizations/{organization-name}/partitions/{partition-name}

https://dcnm-ip/rest/auto-config/dci/extended-partitions/organizations/{organization-name}/partitions/{partition-name}?detail=true

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

extended-partition

O

Extended partition