It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

REST API accessing files containing special characters in their name or path

File names and paths in REST API endpoints

Bitbucket Server REST API endpoints provide the ability to check details on files and these files may contain some special characters.

For example the following endpoint can be used to retrieved the raw content of a file

/rest/api/1.0/projects/<project>/repos/<repository>/raw/<path/to/file>/filename.extension

 

What are special characters in the path or the filename?

It could be anything, but the ones we have seen the most are the following:

% (e.g. as part of %20)

- #

 

What to do about those?

Simply encode them when using the endpoint, for example by using the ASCII Encoding Reference page.

The encodings for the examples above are the following:

%: %25

- #: %23

 

With an example

If the path to the file is "test%20special#character/HelloWorld.java", the REST API endpoint can be called in the following way:

/rest/api/1.0/projects/<project>/repos/<repository>/raw/test%2520special$23character/HelloWorld.java

 

0 comments

Comment

Log in or Sign up to comment
Community showcase
Published in Bitbucket Pipelines

Building a Bitbucket Pipe as a casual coder

...ipe.sh :  #!/bin/bash source "$(dirname "$0")/common.sh" enable_debug extra_args="" if [[ "${DEBUG}" == "true" ]]; then extra_args="--verbose" fi # mandatory variables R...

3,011 views 1 20
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