Discard local changes

POST https://{controlplane_path}/api/1/rest/public/apim/discard_changes/{path_to_apiversion_or_service}

Important: This API works for both Classic and APIM 3.0 assets.

Overview

Discard local changes to the listed assets in the Classic API version or APIM 3.0 Service.

Note: You can track a maximum of 1000 assets per project. If a check-in would exceed 1000 assets in the repository or if you try to check out a project with more than 1000 assets, an error is thrown.

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 can't use SnapLogic service accounts to call any of the SnapLogic API Management Git operation APIs.

Request header

Use the application/json content type with basic authentication (email and password) or a JWT. For examples, refer to Authentication.

Example

This example uses Basic authentication. For a JWT example, refer to Authentication.

curl -X 'POST' \
  'https://elastic.snaplogic.com/api/1/rest/public/apim/discard_changes/acme/apim/BookStore/1.0' \
  -H 'Authorization: Basic {base64_encoded email:password}' \
  -H 'Content-Type: application/json' \
  -d '{
  "assets": ["file.txt"]
}'

Response


{
    "response_map": [
        {
            "org_name/apim/api/1.0": {
                "status": "updated",
                "overwritten": [
                    "file.txt"
                ],
                "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.
`ignored`	array	An empty list.
`updated`	array	An empty list.
`created`	array	An empty list.
`error_msgs`	array	Any error messages that were thrown during the process.

Error handling


HTTP status codes	Message	Resolution
400	Org not found for the user	Verify the Org name in the API version path is correct.
401	Unauthorized	Verify your credentials and permissions.