HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

Retrieve a configuration information by name

get
https://switch-ip/rest/v10.16/configs/

Retrieve a configuration in JSON or CLI format, or the difference between this and another configuration.

This URI is not supported by Notifications or NAE.

Path Params
string
required

Configuration name. Possible values are: 'running-config', 'startup-config' or any other checkpoint configuration name

Query Params
string

Configuration name for the other configuration when getting the diff, as a full URL (i.e. /rest/'version'/configs/startup-config, where 'version' matches the current API version) it also allows for a remote URL (i.e. tftp URL) of a remote file in CLI format

string
enum

Mode to use when performing the diff comparison between two configs (empty defaults to unified)

Allowed:
string

VRF Name if using a remote URL in the diff parameter

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Updated almost 4 years ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain
Updated almost 4 years ago