api.rst

Client - Server API

local

URL Endpoints

HTTP Method	URI
GET	/bootstrap
GET	/bootstrap/config
POST	/nodes
GET	/nodes/{id}
PUT	/nodes/{id}/startup-config
GET	/nodes/{id}/startup-config
GET	/actions/{name}
GET	/files/{filepath}
GET	/meta/{actionsnodes}/{PATH_INFO}

GET bootstrap script

Note

For every request, the bootstrap controller on the ZTPServer will attempt to perform the following string replacement in the bootstrap script): “$SERVER“ ---> the value of the “server_url” variable in the server’s global configuration file. This string replacement will point the bootstrap client back to the server in order to enable the client to make additional requests for further resources on the server.

• if the server_url variable is missing from the server’s global configuration file, 'http://ztpserver:8080' is used by default
• if the $SERVER string is missing from the bootstrap script, the controller will log a warning message and continue

GET bootstrap logging configuration

POST node details

Send node information to the server in order to check whether it can be provisioned.

GET node definition

Request definition from the server.

PUT node startup-config

This is used to backup the startup-config from a node to the server.

GET node startup-config

This is used to retrieve the startup-config that was backed-up from a node to the server.

GET actions/(NAME)

GET resource files

GET meta data for a resource or file