Deployments
You can deploy CDK connectors to your Tray platform using Deployments API.
Check status
Returns the deployment status of a given connector name and version.
Connector name, version and id are required path parameters.
The id is the deployment id which is returned by the create deployment request.
Response Examples
{
"id": "3c5exxx-xxxx-xxxx-xxxx-xxxxxxxx2387",
"deploymentStatus": "Deploying",
"connectorName": "my-connector",
"connectorVersion": "1.0"
}Deploy Connector
Deploys a CDK connector to the Tray platform.
Connector name and version are required path parameters and should match the name and version in your connector.json. Currently, only version 1.0 is supported.
To prepare request body, you need to follow this guide that will generate JSON request payload.
A success response from the API will indicate only that your connector has passed preliminary validation and has been queued for deployment.
In this response you will also recieve a deployment id which you can use to check the status of your deployment.
Additionaly, recieving the property repeatDeployment with a value of true in your response indicates that your deployment has been skipped as there is currently already a deployment in progress for this connector.
Response Examples
{
"id": "3c5exxx-xxxx-xxxx-xxxx-xxxxxxxx2387",
"deploymentStatus": "Deploying",
"connectorName": "my-connector",
"connectorVersion": "1.0"
}