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 > APIs.
The APIs screen appears.
If your peak organization does not have any configured endpoints, you will be prompted to add one. 
If you have already have configured endpoints, they will all be listed here.


Deploy Endpoint

An endpoint defines the base URL of your API and allows multiple configurations to be accessed from the same endpoint.

Endpoints can contain multiple stacks, each pointing to a different configuration with a distinct URL.
Multiple stacks allow A/B or Blue/Green tests to be performed.

To deploy an endpoint:

  1. From the APIs screen, click DEPLOY ENDPOINT.
    The Deploy Endpoint 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 Endpoint fields

Complete the following fields when configuring your endpoint, additional stacks or shadow stacks.


Endpoint Name

This is the name of the endpoint. It will be added to the end of the Endpoint URL.

  • Only alphanumeric characters and hyphens can be used.

  • The Endpoint URL can be copied by clicking the copy icon.

If you are configuring an additional stack or shadow stack, you cannot edit the endpoint name.


Stack Name

This is the name of the stack for your endpoint.

The name of the stack is added to the end of the Endpoint URL.

If you will only have one stack, a sensible name is ‘main’.

  • Only alphanumeric characters and hyphens can be used.

  • The Stack URL can be copied by clicking the copy icon


Select Configuration

The drop-down lists all of the configurations that have been created for your Peak organization.


Preview Configuration Icon and Clone Configuration Icon

Previewing

To preview a configuration:

  • Click the Preview icon.
    This will open the configuration side panel in non-editable mode.

Cloning

To clone the configuration:

  • Click the clone icon.
    This will open the configuration side panel in edit mode.

  • Enter a new configuration name.

  • Make the required changes to the other fields.

  • Click SAVE
    The system replaces the old configuration and saves the new configuration as a new entry under the Configuration tab.


NEW CONFIGURATION

Click here to launch the New Configuration side panel.

For details of how to create configurations, see APIs: Creating a configuration.


Traffic Routing

This is used for multi-stack deployments. It enables you to define how much of the total API traffic will be routed to your endpoint stack.

For shadow stacks, the traffic will be a copy of traffic going to the live stack.

The default traffic routing values are:

  • Single Stack - 100%

  • Multi Stack - 5%

  • Shadow Stack - 5%


Watchers

Watchers can be added to be notified in any or all of the following events:

  • If the stack deployment fails

  • If the stack deploys successfully

  • If a stack is deleted