Pull latest changes from Git

POST /apim/pull/{path_to_apiversion}

Overview

This API updates the API version with the latest files from the associated Git repository. Equivalent to git pull.

You can use Git APIs in Continuous Integration / Continuous Deployment (CI/CD) workflows to pull files from Git repositories.

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.

Request

 POST https://{controlplane_path}/api/1/rest/public/apim/pull/{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: `/org_name/apim/api/apiversion` 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

None

Response

Response body


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

{
    "response_map": {
        "status": "up-to-date"
    },
    "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 flies that were overwritten in the API version in 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.
`up-to-date`	string	This reponse is returned when your branch is up to date.