Untrack API version with Git

GET https://{controlplane_path}/api/1/rest/public/apim/untrack/{path_to_apiversion}

This API stops tracking API version with Git.

Prerequisites

  • Write access to the assets to add or update.

Limitations

  • You cannot use SnapLogic service accounts to call any of the SnapLogic API Management Git operation APIs.

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

{
    "response_map": {
        "untracked_projects": [
            "path_to_apiversion"
        ]
    },
    "http_status_code": 200
}
Key Type Description
untracked_projects array An array object containing paths to API versions that need to be untracked.
path_to_apiversion string Specify path to required API version.

Response


response:
{
    "response_map": {
        "untracked_projects": [
            "/org_name/apim/api/apiversion"
        ]
    },
    "http_status_code": 200
}
Key Type Description
path to api version array The path to the different API versions.

Error handling

{
    "http_status_code": 400,
    "response_map": {
        "error_list": [
            {
                "message": "Project is not backed by a Git repository: automation/apim/apiversion/1.0"
            }
        ]
    }
}
HTTP status codes Status Description Resolution
400 Bad Request This response is sent when a request has missing paramteres. Check if the branch is backed by Git repository.