Compare two refs

Lists the files that differ between two refs, as a deployment from the source into the target would see them.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Lists the metadata files that differ between two refs. status is what deploying the source into the target would do to the file: ADD, MODIFY or DELETE.

Profiles and Permission Sets are not listed here; see List deployable permissions.

Paging

Without limit the whole list is returned in one response. With limit the list is paged: meta.hasNext says whether another page exists and meta.next is its URL. total always counts every match, whatever the page.

Two unrelated orgs can differ in more than 100,000 files, so pass limit, or narrow the comparison with path, whenever the refs may be far apart.

Response fields

FieldDescription
sourceCommit, targetCommitThe commits the two refs resolved to.
incompatibletrue when the two branches use different source formats and cannot be deployed between.
totalFiles that differ (under path, if given), across all pages.
files[].pathRepository path of the file.
files[].statusADD, MODIFY or DELETE.
Query Params
string
required

The ref the changes come from: a branch name or commit SHA.

string
required

The ref to compare against: a branch name or commit SHA.

string

Only this file, or the files under this directory, e.g. src/classes.

int32

Page size, 1 to 1000. Omit to get every file in one response.

int32

Number of files to skip. Defaults to 0.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json