Releases
Releases in Type CMS enable bulk content publishing and unpublishing via a single interface or API. Users can queue content updates and deploy them to specific environments at scheduled times. This feature supports synchronization with code updates, ensuring consistent rollouts of new features and content. By automating these processes, Type CMS reduces errors and improves efficiency in content deployment.
get
List all releases in a project
Required attributes
| projectId | string | Your projectId |
Optional attributes
| None |
Request
get
/api/projects/:projectId/releases
Response
get
Retrieves a single release based on the provided release ID
Required attributes
| projectId | string | Your project ID |
| releaseId | string | The ID of the release to retrieve |
Optional attributes
| None |
Request
get
/api/projects/:projectId/releases/:releaseId
Response
post
Creates a new release. Creating a new release will not deploy the staged content, see the deploy method for additional information.
Required attributes
| projectId | string | Your project ID |
| title | string | The name of the new release |
Optional attributes
| description | string | A description for the new release |
| pipeline | pipelineObject[] | An array of pipeline objects containing entry IDs and environment IDs to publish to or unpublish from |
Request
post
/api/projects/:projectId/releases
Response
patch
Updates attributes for a release.
Required attributes
| projectId | string | Your project ID |
| releaseId | string | The ID of the release to update |
Optional attributes
| title | string | The name for the release |
| description | string | A description for the release |
| pipeline | pipelineObject[] | An array of pipeline objects containing entry IDs and environment IDs to publish to or unpublish from |
Request
patch
/api/projects/:projectId/releases/:releaseId
Response
delete
Deletes a release from your project.
Required attributes
| projectId | string | Your project ID |
| releaseId | string | The ID of the release to remove |
Optional attributes
| None |
Request
delete
/api/projects/:projectId/releases/:releaseId
Response
get
Deploys all staged items in a release.
Required attributes
| projectId | string | Your project ID |
| releaseId | string | The ID of the release to remove |
Optional attributes
| None |
Request
get
/api/projects/:projectId/releases/:releaseId/deploy
Response
Last modified 7/6/2024, 5:26:11 PM