REST API reference

The IBM™ UrbanCode™ Deploy server and blueprint design server each have a separate REST interface. You can use these REST interfaces to automate tasks on those servers.

Running REST commands
Many different programs can run REST commands. To run the command, you call a method on a REST resource and pass parameters or a request in JSON format.
Examples of REST API commands
Many REST and command-line client commands have examples in their help topics. A few more examples using various programming languages and scenarios are provided here. The commands are similar for the server and for the blueprint design server.
Authenticating for REST commands
The way that you authenticate to run REST commands depends on how the server is set up and the tool that you are using to run the commands.
Deploying applications by using REST commands: An example
The following example describes how to use the REST commands to deploy an application.
Provisioning environments by using REST commands: An example
The following example describes how to use the REST commands to provision an environment through the blueprint design server and engine.
REST commands for the IBM UrbanCode Deploy server
The following list shows the commands that are available for the IBM UrbanCode Deploy server.
REST commands for the blueprint design server
The following list shows the commands that are available for the blueprint design server.

Parent topic: Extending product function