Deployments

You can deploy CDK connectors to your Tray platform using Deployments API.

Deploy Connector

post/cdk/v1/deployments/connectors/{connector-name}/versions/{connector-version}/deploy-connector-from-source
Detailed documentation on deploying connectors can be found here.

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.

SecuritybearerAuth
Request
path Parameters
connector-name
required
string

The hypenated name of the connector being deployed.

Example: my-connector
connector-version
required
string

The version of the connector being deployed.

Example: 1.0
header Parameters
Authorization
required
string

The RBAC token. Follow this page to know how to generate one.

Example: Bearer 3fd74d349xxxxxxxxxxxxxxxxxxxxxxxxd90df521
Responses
200

OK - Connector deployment request recieved, your connector deployment will now be in progress unless you recieved repeatDeployment with a value of true in your response, which indicates a skipped deployment because there is already a deployment in progress for this connector.

Response Schema: application/json
id
string

The deployment id of the connector deployment request.

repeatDeployment
boolean

Indicates that the deployment request was skipped because there is already a deployment in progress for this connector.

deploymentStatus
string

The status of the deployment request.

Enum: "Deployed" "Failed" "Deploying"
connectorName
string

The name of the connector being deployed.

connectorVersion
string

The version of the connector being deployed.

400

Invalid input

401

Unauthorized - Verify the token validity

403

Forbidden

404

Not found

429

Limit exceeded

500

Internal error

Request samples 
Response samples 
application/json
{
  • "id": "3c5exxx-xxxx-xxxx-xxxx-xxxxxxxx2387",
  • "deploymentStatus": "Deploying",
  • "connectorName": "my-connector",
  • "connectorVersion": "1.0"
}
Check status
get/cdk/v1/deployments/connectors/{connector-name}/versions/{connector-version}/{id}
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.


SecuritybearerAuth 
Request 
path Parameters
connector-name
required
string
The hypenated name of the connector being deployed.


 
 Example:  my-connector
connector-version
required
string
The version of the connector being deployed.


 
 Example:  1.0
id
required
string
The deployment id given to you in the response from the original deployment request. 
 You can also pass latest to retrive status of last deployment of the connector.


  Examples: 
3c5exxx-xxxx-xxxx-xxxx-xxxxxxxx2387
latest
header Parameters
Authorization
required
string
The RBAC token. Follow this page to know how to generate one.


 
 Example:  Bearer 3fd74d349xxxxxxxxxxxxxxxxxxxxxxxxd90df521
Responses 
200
OK - Returns the deployment status for the connector version.


Response Schema: application/json
id
string
The deployment id of the connector deployment request.


 
deploymentStatus
string
The status of the deployment request.


 Enum: "Deployed" "Failed" "Deploying"  
connectorName
string
The name of the connector being deployed.


 
connectorVersion
string
The version of the connector being deployed.


 
400
Invalid input


401
Unauthorized - Verify the token validity


403
Forbidden


404
Not found


429
Limit exceeded


500
Internal error


Request samples 
Response samples 
application/json
{
  • "id": "3c5exxx-xxxx-xxxx-xxxx-xxxxxxxx2387",
  • "deploymentStatus": "Deploying",
  • "connectorName": "my-connector",
  • "connectorVersion": "1.0"
}