Add a Git tag

POST /project/git-tag/{project_path}

Overview

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

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 Git operation APIs.

Request

 POST https://{controlplane_path}/api/1/rest/public/project/git-tag/{project_path}

Path Parameters

Key Description
controlplane_path Required. The path to the SnapLogic control plane.

Example: control-plane-name.snaplogic.com

Where control-plane-name is the control plane you are using. For example,
  • elastic
  • uat
  • emea
project_path
Required. The path to the SnapLogic project.

Format: /{env_org}/{project_space}/{project_name}

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_sha": "...",
    "tag": "...",
    "message": "...",
    "tagger": "[email protected]",
    "commit_sha": "..."
  },
  "http_status_code": 200
}