Create API version from Git

POST /apim/create-version/{path_to_apiversion}

Overview

This API creates an API version using the files in the specified Git repository and branch.

Note: You can track a maximum of 1000 assets per API version. If 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

Environment (Org) admin permissions
Git hosting provider requirements:
- The environment (Org) must be correctly configured to use a Git hosting provider supported by SnapLogic.
- The user must have an authenticated account with the Git hosting provider.
Learn more: SnapLogic - Git Integration

Limitations

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

Request

 POST https://{controlplane_path}/api/1/rest/public/apim/create-version/{path_to_apiversion}

Path parameters


Key	Description
`controlplane_path`	Required. The path to the SnapLogic control plane: `elastic.snaplogic.com` For the UAT or EMEA control plane, substitute the name for `elastic`. For example: `uat.elastic.snaplogic.com` `emea.snaplogic.com`
`path_to_apiversion`	Required. The path to the SnapLogic API version. Format: `/create-version/{env_org}/{project_space}` Important: The path comparison is case-sensitive

Query parameters

None.

Request header

Basic authentication

In the request header, specify Basic for authorization, add your credentials (Login and password of your SnapLogic user or service account), and specify application/json for content type. For more details on accounts refer to Manage accounts.


Authorization: Basic {base64_encoded <email>:<password>}
Content-Type: application/json

Example of Basic authenthication using Postman

Request body

{
"repo": "...",
"ref": "",
"tags": ["test"],
"description": "test",
"plex_path": "/org_name/protect_space/plex"
}


Key	Type	Description
`repo`	string	The Git repository containing the files to use with the new API version.
`ref`	string	The name of the branch containing the files to use with the new API version.
`tags`	array	The Git tag to associate with the latest files in the Git repository.
`description`	string	The description of Git Tag.
`plex_path`	string	The path of the Snaplex/Groundplex selected.

Response

Response body

{
    "response_map": [
        {
            "org_name/apim/api/apiversion": {
                "status": "updated",
                "overwritten": [],
                "ignored": [],
                "updated": [],
                "created": [
                    "Company name",
                    "file.zip",
                    "file.txt",
                    "mypipeline",
                    "mypipelineTask",
                    "test.txt"
                ],
                "error_msgs": []
            }
        }
    ],
    "http_status_code": 200
}


Key	Type	Description
`status`	string	The status of the git checkout command performed using the Public API.
`overwritten`	array	An empty list. No files are overwritten, because the project is new.
`ignored`	array	Asset files that exist in the Git repository but were not copied into the project.
`updated`	array	An empty list. No files are updated, because the project is new.
`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.