Create a Git branch

POST /apim/git-branch/{path_to_apiversion}

Overview

This API duplicates the Git branch that is associated with the API version and uses the currently tracked commit as the head of the new branch.

Prerequisites

  • Write access to the API version
  • 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.
    • The project has checked out a Git repository.

    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/git-branch/{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

 {
  "branch_name" : "..."
}
Key Type Description
branch_name string The name of the Git branch to create.

Response

Response body

 {
  "response_map": {
    "branch_name": "...",
    "ref": "refs/heads/...",
    "sha": "..."
  },
  "http_status_code": 200
}
Key Type Description
branch_name string The name of the Git branch created
ref path Head points to the specific branch.
sha string Gives the unique ID of the commit

Error handling

{
    "http_status_code": 409,
    "response_map": {
        "error_list": [
            {
                "message": "Branch API version already exists for repo"
            }
        ]
    }
}
HTTP status codes Status Description Resolution
409 Conflict This response is sent when a request conflicts with existing of the same branch. Change the name of the branch or delete the existing branch.