Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,301,037
Community Members
 
Community Events
165
Community Groups

Retrieving a file from bitbucket REST API v2.0 ?

I have a powershell script which grabs a file from one of our repositories via the REST 1.0 API but I see that's being depreciated and retired soon(ish). 

I'm trying to update my code to grab the file using the 2.0 REST API but having a lot of trouble.

Before trying to write code I'm simply trying to get a curl request to work. I'm using the following: 

curl --user myuser@mydomain.com:redacted "https://api.bitbucket.org/2.0/repositories/MyCompany/myrepo/downloads/Scripts/Environment Setup/test.txt"

Enter host password for user 'myusername@mydomain.com': redacted

{"type": "error", "error": {"message": "Resource not found", "detail": "There is no API hosted at this URL.\n\nFor information about our API's, please refer to the documentation at: https://developer.atlassian.com/bitbucket/api/2/reference/"}}

 

Why am I getting resource not found? Is download the right API call to download a file or should I be using something else?

 

Thanks,
Brad

3 answers

1 accepted

1 vote
Answer accepted

Actually I just realized that "downloads"  isn't what I want. Instead I needed to use:

curl --user myuser@mydomain.com:redacted "https://api.bitbucket.org/2.0/repositories/mycompany/myrepo/src/master/path/to/file.txt"


That works with curl but not with powershell's Invoke-RestAPI. I get a forbidden:

$filepath = "myrepo/src/master/path/to/file"

$uri = "https://api.bitbucket.org/2.0/repositories/MyCompany/$($filepath)"

# Get the files from bitbucket (GIT)
Invoke-RestMethod -Credential $cred -Uri $uri -Proxy $proxyUri -OutFile $destination

----


Exception : System.Net.WebException: The remote server returned an error: (403) Forbidden.

Seems the new bit bucket API expects credentials to be send in the request - and Invoke-RestMethod sends them after its prompted to causing an immediate 403 forbidden. The 1.0 api doesn't have this issue for whatever reason. 

The (ugly) solution is:

$cred = Get-Credential


$uri = "https://api.bitbucket.org/2.0/repositories/MyCompany/$($filepath)"
$username = ($cred.GetNetworkCredential()).username
$password = ($cred.GetNetworkCredential()).password
$base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $username,$password)))

# Get the files from bitbucket (GIT)
Invoke-RestMethod -Headers @{Authorization=$("Basic {0}" -f $base64AuthInfo)} -Uri $uri -Proxy $proxyUri -OutFile $destination
Like Corwin Myers likes this

Hi Brad,

Thanks for writing out the steps. I'm also trying to use a PowerShell solution to download files via the API.

 

Does this approach still work for you or have you had to change it?

 

I've tried both the URI you listed (adapted for my repository) as well as the one in the reference documentation:

$uri = https://<hostname>/rest/api/1.0/users/<myName>/<myRepo>/path/to/file

But I am getting either error 401, not authorized, or only a json output description of the directory rather than the files.

I generated an admin level pass token and set my repo to public. I'm using the same user name I use in the browser to log in and copied the credential generation you used.

Were there any other steps that might have been necessary for you? For example, how is the proxyUri  parameter determined? Also, is there a way to verify the correct uri definitively?

Thank you!

@Hbandhu I am having the same issue with a feature branch. It may be that we need to look up the SHA of the HEAD of the feature branch and use .../src/SHA/path/to/file.txt

... although I am finding that prospect not very enticing.

This is only working for master or ci branch, unable to read a file from feature branch

I had the same issue, to read from a particular file, instead of adding the branch name on the url, send a post request for the branch using -F branch=<your-branch>

Suggest an answer

Log in or Sign up to answer
TAGS
Community showcase
Published in Bitbucket

Git push size limits are coming to Bitbucket Cloud starting April 4th, 2022

Beginning on April 4th, we will be implementing push limits. This means that your push cannot be completed if it is over 3.5 GB. If you do attempt to complete a push that is over 3.5 GB, it will fail...

2,263 views 2 9
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you