Checkout API version from Git

POST https://{controlplane_path}/api/1/rest/public/apim/checkout/{path_to_apiversion}

Overview

This API checks out the specified Git branch for the specified API version.API version (equivalent to git checkout).

You can use Git APIs in Continuous Integration / Continuous Deployment (CI/CD) workflows to pull files from Git repositories. You can use this API either to update a project to a newly tagged version or to revert to a previously stable tag.

Note:

The API version must exist.
You can track a maximum of 1000 assets per API version. If either a check-in would exceed 1000 assets in the repository or if you try to check out a project with more than 1000 assets, an error is thrown.

Prerequisites

Write access to the assets to be added or updated

Limitations

You cannot use SnapLogic service accounts to call any of the SnapLogic API Management Git operation APIs.

Response

 {
  "response_map": {
    "status": "",
    "overwritten": [ ... ],
    "updated": [ ... ],
    "error_msgs": [ ... ],
    "created": [ ... ],
    "ignored": [ ... ]
  },
  "http_status_code": 200
}


Key	Type	Description
`status`	string	The status of the Git checkout command performed using the Public API.
`overwritten`	array	The list of files that were overwritten in the API version in the SnapLogic specified project.
`ignored`	array	Asset files that exist in the Git repository but were not copied into the project.
`updated`	array	The list of files that were updated in the API version in SnapLogic specified project.
`created`	array	Assets files that were copied from the Git respository into the API version
`error_msgs`	array/string	Any error messages that appear when the Git checkout command is performed.