Table of contents

Deploy an asset as a web service

A web service generates a REST API endpoint for an external application to call. The web service is visible to authenticated users only.

The following asset types can be deployed as a web service:

  • Models
  • Scripts
Restriction: You cannot deploy Custom Batch models as a web service (must be Custom Online).

Deploy a model as a web service

Open the Assets tab in the Project release details page. Select a model from the left side of the assets table, and then, in the right side, click the button to create a web service. The Create web service deployment window opens.

Create web service deployment

You are prompted with the following fields:
Name
Specify a name for the asset that will be deployed. Use only lowercase alphanumeric characters and hyphens, up to 26 characters.
URL
View the generated URL for the web service.
Model version
Select from available versions. The latest is version is the default.
Web service environment
Select from one of the IBM generated scripts, or select Custom for a custom script that you generate. If you select Custom, select the custom script to associate to the model deployment.
Worker
Choose a worker for your deployment.
Reserve resources
  • If you do not enable Reserve resources, the deployment uses resources only as required, but there is no guarantee that these resources will be available at the time of need
  • If you enable Reserve resources, specify a reserved set of CPU and memory from the available pool to allocate to the deployment. No other deployments can use these resources when they are reserved.
Replicas
Specify the number of replicas to dedicate to this deployment.

Deployed web service overview

Deploy a script as a web service

Open the Assets tab in the Project release details page. Select a script from the left side of the assets table, and then, in the right side, click the button to create a web service. The Create web service deployment window opens.

You are prompted with the following fields:
Name
Specify a name for the asset that will be deployed. Use only lowercase alphanumeric characters and hyphens, up to 26 characters.
URL
View the generated URL for the web service.
Worker
The worker for the deployment is shown.
Reserve resources
  • If you do not enable Reserve resources, the deployment uses resources only as required, but there is no guarantee that these resources will be available at the time of need
  • If you enable Reserve resources, specify a reserved set of CPU and memory from the available pool to allocate to the deployment. No other deployments can use these resources when they are reserved.
Replicas
Specify the number of replicas to dedicate to this deployment.