Discard local changes to an asset

POST /project/discard_changes/{project_path}

Overview

Discard local changes to the listed assets. Equivalent to git restore file_name, which retrieves the asset from the repository and overwrites the local changes. If an asset doesn't exist or isn't tracked by Git, the response includes the appropriate error message.

Prerequisites

  • 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.

    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/discard_changes/{project_path}

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.snaplogic.com
  • emea.snaplogic.com
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

In the request header, specify Basic for authorization, add your credentials, and specify application/json for content type:


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

Request body

A list of assets to discard.

{
    "asset_path_list" : ["org1/project1/asset1", "org1/project1/asset2"]
}
        
Key Type Description
"asset_path_list" array A comma-separated list of the paths and asset name for which to discard changes. For example, to discard changes to an account named Shared basic in a my-space/shared folder in the my-env environment, use the following:
"asset_path_list" : ["/my-env/my-space/shared/Shared basic Auth"]

Response

Response body

 {
    "response_map": [
        {
            project_path: {
                "status": "updated",
                "overwritten": [
                assets-with-discarded-changes
                ],
              "ignored": [],
              "updated": [],
              "created": [],
              "error_msgs": []
             }
        }
    ],
    "http_status_code": 200
}
  
Key Type Description
status string The status of the process.
overwritten array The assets whose state was refreshed from the repository.
ignoredarrayAn empty list.
updated array An empty list.
createdarrayAn empty list.
error_msgs array Any error messages that were thrown during the process.