Retrieve Git tags

GET https://{controlplane_path}/api/1/rest/public/apim/git-tag/{path_to_apiversion}

Overview

This API retrieves the list of Git tags associated with the commit that is currently tracked by the API version. The tags are retrieved directly from either GitHub or GHES.

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

 GET 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: 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

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 authentication using Postman

When using JWT authentication, the API requests includes specific headers. In the request header, specify Bearer Token for authorization, add the token, and specify application/json for content type. These headers are automatically added when you configure bearer token authentication in your API client. The authorization header contains the word Bearer followed by a space and your JWT token.


Authorization: Bearer Token {token}
Content-Type: application/json

Example of JWT authenthication using Postman

Request body

None.

Response

 {
  "response_map": [
    {
      "tag": "apiversion_tag",
      "commit_sha": "4dd92e750bd4d9be305c3d94479bc50bf853dfc5"
    },
    ...
  ],
  "http_status_code": 200
}
Key Type Description
tag string The specified git tag.
commit_sha string The unique ID of the commit.