Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This page describes the one API offered by the proxy service that enables rerouting between environments.

API

...

ServiceAPIMethod
proxy/redirectPOST


Workflow: Check Redirect Workflow

Input

...

NameSourceMandatoryTypeSpecial FormatDescription
_envbodyYESStringN/AThe code of the environment to redirect to.
_envauthbodyYESStringN/AThe soajsauth of the environment the calls is redirected to.
proxyRoutebodyYESStringN/AAn encoded value of the service/api to redirect to in the requested environment.

Example

...

Code Block
languagebash
titleProxy call example
linenumberstrue
CURL -X POST "http://127.0.0.1:4000/proxy/redirect?__env=dev&__envauth=Basic c29hanM6QzAzYmhnVWhSeEx4bUhURjFNUkFsVnh5Zi1VMzNNQXNnV2Y=&proxyRoute=%2serviceName%2FapiName" -d '%data that should be provided to the proxyRoute%'service deployed in the requested environment%'

Response:

Since the proxy only reroutes the request to the designated service, the response is thus dependent on the API being invoked from the requested service.