API
Description
Starts a local HTTP server that listens for REST API requests.
Usage
cm api [(-p|--port)=<portnumber>] [(-r|--remote)]
Options
Option / Argument | Description |
---|---|
-p | --port | Tells the server to listen on port <portnumber> instead of 9090. |
-r | --remote | Allows incoming remote connections. This means connections that come from other hosts instead of the local one. |
Help
Remarks
The cm api command allows programmers to perform Unity VCS client operations in their machines. Read the Unity VCS API Guide for more information:
https://www.plasticscm.com/documentation/restapi/plastic-scm-version-control-rest-api-guide
By default, the API listens for local connections only, on port 9090.
Press the Enter key to stop the server.
Examples
cm api
(Starts the API listening on port 9090, local connections only.)
cm api -r
(Starts the API listening on port 9090, allowing any incoming connection.)
cm api --port=15000 -r
(Starts the API listening on port 15000, allowing any incoming connection.)