Config

Network configuration and fabric management API

get

https://localhost:3000/apihttp://localhost:3000/api

/config

Get configuration log details and intent information

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/config

HTTPcURLJavaScriptPython

GET /api/config HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/config/getconfig

Get configuration values for a specific device

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

deviceipstringRequired

Device IP address

Example: {"value":"10.4.4.55"}

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/config/getconfig

HTTPcURLJavaScriptPython

GET /api/config/getconfig?deviceip=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/config/is-valid

Validate YAML configuration syntax and structure

Responses

200

OK - Returns validation result

No content

500

Internal Server Error

get

/config/is-valid

HTTPcURLJavaScriptPython

GET /api/config/is-valid HTTP/1.1
Host: localhost:3000
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/config/configslisttorestore

Returns list of available configuration backups that can be restored for devices.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/config/configslisttorestore

HTTPcURLJavaScriptPython

GET /api/config/configslisttorestore HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/config/getrmainfo

Get list of devices marked for RMA (Return Merchandise Authorization)

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/config/getrmainfo

HTTPcURLJavaScriptPython

GET /api/config/getrmainfo HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/config/backupconfig

Backup configuration for specified devices

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

400

Bad Request - No data provided

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/config/backupconfig

HTTPcURLJavaScriptPython

POST /api/config/backupconfig HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ip": {
            "type": "string",
            "examples": null
          }
        }
      }
    }
  }
}

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/config/replaceConfig

Replace device configuration with uploaded file

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

multipart/form-data

deviceipstringRequired

Device IP address (e.g., 10.4.4.55)

filestringRequired

Configuration file to upload

Responses

200

OK

No content

400

Bad Request - deviceip and file are required

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/config/replaceConfig

HTTPcURLJavaScriptPython

POST /api/config/replaceConfig HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 33

{
  "deviceip": "text",
  "file": "text"
}

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/config/restoreconfig

Restores device configurations from backup for specified devices.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

400

Bad Request - No data provided

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/config/restoreconfig

HTTPcURLJavaScriptPython

POST /api/config/restoreconfig HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ip": {
            "type": "string",
            "examples": null
          },
          "timestamp": {
            "type": "string",
            "examples": null
          }
        }
      }
    }
  }
}

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/config/jsondataforyaml

Convert YAML configuration file to JSON format for a specific fabric

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

fabricNamestringRequired

Fabric name to get YAML configuration for

Example: {"value":"sonic"}

Responses

200

OK

No content

400

Bad Request - fabricName is required

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/config/jsondataforyaml

HTTPcURLJavaScriptPython

GET /api/config/jsondataforyaml?fabricName=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/config/existing-configs

Get existing device configurations from Fabric Manager instances

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/config/existing-configs

HTTPcURLJavaScriptPython

GET /api/config/existing-configs HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/config/fabrics

Get list of all fabrics from all Fabric Manager instances

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/config/fabrics

HTTPcURLJavaScriptPython

GET /api/config/fabrics HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/config/config-yaml-files

Get all configuration YAML files content from the server

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/config/config-yaml-files

HTTPcURLJavaScriptPython

GET /api/config/config-yaml-files HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content