post

/promote

Deploy an API proxy to a runtime group, or promote a deployed API proxy between runtimes to manage the deployment of your proxies quickly and efficiently.

The YAML configuration file is the input parameter. It provides the source and target runtime group. The API proxy revision currently deployed on source runtime is deployed to target runtime. If no source runtime is provided, the latest revision available is deployed to the target runtime.

Response is the URL of the deployed API proxy and a set of API keys (if secured) that can be used to access the deployed API proxy.

Request Parameters

2 Headers

Request Body

Form data (multipart/form-data)
config
file

YAML configuration file that defines the proxy.

required
source
string

Source runtime group to refer to deploy revision on target runtime group. If no runtime group is provided, latest revision of the proxy will be deployed to target runtime.

target
string

Target runtime group where the proxy revision is to be deployed.

required

Responses

URL of the deployed API proxy and a set of API keys that can be used to access the deployed API proxy.

1 Example
Schema
object

Returns the URL and a set of API keys to access the deployed API proxy.

url
string
apiKeys
array[string]
apiKeysByApp
array[object]

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.