Add a Git tag

POST /apim/git-tag/{path_to_apiversion}

Overview

This API associates the specified Git tag with the commit that is currently tracked by the API version.

Prerequisites

  • Write access to the project
  • 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-tag/{path_to_apiversion}

Path Parameters

Key Description
controlplane_path Required. The path to the SnapLogic Control Plane.

Example: cdn.elastic.snaplogic.com

For other control planes, substitute the subdomain name for elastic. For example:
  • cdn.uat.snaplogic.com
  • cdn.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

Specify Basic for authorization and application/json for content type.


Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

Request Body

{
  "tag" : "...",
  "message" : "..."
 }
Key Type Description
tag string The Git tag to associate with the latest files in the Git repository.
message string Additional information about the added tag.

Response

Response Body

{
    "response_map": {
        "tag": "Apiversion_tag",
        "message": "Tag created via public api",
        "tag_sha": "ae90e20f77221ccc325a98c02ec064caf2f62307",
        "commit_sha": "4dd92e750bd4d9be305c3d94479bc50bf853dfc5",
        "tagger": "[email protected]"
    },
    "http_status_code": 200
}
Key Type Description
tag string The specified git tag.
message string The message related to git tag.
tag_sha string The unique ID of the tag when created.
commit_sha string The unique ID of the commit.
tagger string Email ID of the tagger.

Error Handling

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