Deployment

The deployment object is used to track deployments and changes to your system.

Param	Type	Required	Nullable	Description
`artifactId`	string	✅	❌	ID of the artifact from Shipbot.io to deploy.
`version`	str	✅	✅	The version can be any string. If you don't use versions you can set this as the commit SHA.
`environment`	str	✅	✅	This should match the environment name created in Shipbot.io. By default "Production" is created.
`commitSha`	str	✅	❌	Commit SHA reference.
`user`	str	✅	❌	This can be any string but ideally it matches the username of the user who is deploying within the deployment system. For example in Github it would be the Github username.
`branch`	✅	The branch that is being deployed.
`status`	str	❌	❌	One of `STARTED`, `SUCCEEDED`, `FAILED`.
`changelog`	str	❌	❌	This can be a URL to a change log or the changelog notes itself.
`description`	str	❌	❌	This can be further information on the deployment that wouldn't be considered part of the changelog.
`link`	str	❌	❌	This should link to an external place where more action on the deployment can take place for example it could be the deployment job in your CI/CD pipeline.
`type`	str	❌	❌	This is a enum describing the deployment strategy. The only option right now is SIMPLE.

Create a Deployment

curl -X POST https://api.shipbot.io/deployment \
  -H "X-Api-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"version":"0.0.1","artifactId":1,"environment":"PRODUCTION","commitSha":"1234567890","user":"my-github-username","branch":"main"}'

Create a Deployment​

Create a Deployment