Cisco Cisco Prime IP Express 8.3 Technical References

Refer to each class resource page for more details on available primitives and optional query
parameters.

Client access is controlled using basic HTTP authentication. This authentication scheme uses simple
base-64 encoding of user credentials which should be secured via HTTPS. User authentication and
authorization are controlled by the Network Registrar installation.

Client login is verified for each request, but if an active server session is present for the authenticated
user, it will be reused. Otherwise an unauthorized error will be returned. The client may respond to this
error by reissuing the request with the required user credentials, or choose to include its credentials with
each request.

The session element can be used to manage the client connection.

Gets the server version string.

Request:

GET /web-services/rest/session 

This request may be used to initiate a client session, since it will verify the client login
like any other request.

Response:

Returns the version string 
Content-Type: text/plain

Logs out the current session and clears all cached user data.

Request:

DELETE /web-services/rest/session

Response:

Content: none

The stats element can be used to query server statistics on local clusters.

Gets the Network Registrar DHCPServerStats object, or an alternate statistics class, if requested.

Request:

GET /web-services/rest/stats/DHCPServer

Response: Returns the DHCPServerStats object, or the alternate statistics class, if requested 

Content-Type: application/xml, application/json 

Query Parameters 
  nrClass: DHCPServer statistics class 

Optional statistics classes that can be requested are: DHCPServerActivityStats,