For more information about all of the stages that are required for deploying an API on Peak, see How to deploy an API on Peak.


Contents

Getting to the screens

Go to Work > Services > APIs.
The APIs screen appears.
If your peak organization does not have any configured API service, you will be prompted to add one. 
If you have already have configured API Services, they will all be listed here.

Deploy Service

An endpoint defines the base URL of your API.

To deploy an endpoint:

  1. From the Services > APIs screen, click DEPLOY SERVICES.
    The Deploy Services screen appears.

  2. Complete the required fields and click DEPLOY (see below for details).
    If the API deployment was successful, the endpoint will appear in the Endpoints tab.

Completing the Deploy API Service fields

Complete the following fields


Service Name

This is the unique name for your Service and is used to generate your URL.


Title

The title should be a suitable and meaningful name for your end user.


Description

Write a short description of your Service API


Service Type

Select Service Type as API for API services.


Select an Image

on the next page, you need to select an image that you have previously created in the image management for the API service.


Instance Configuration

on the next page, you need select instance type for API service.

By default Medium is selected, via clicking on Change Instance you can select an appropriate amount of processing resources for your API.