REST API GET /repos/{owner}/{repo}/pages 404s

[adriangb]

I’m trying a basic GET to the pages API and am getting 404s. For example:

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/repos/octocat/hello-world/pages

Gives me a 404. This is straight from the docs.

I also tried this with some of my repos, which I know have pages configured, and I’m getting the same thing. Other endpoints (like GET /repos/{owner}/{repo}/branches) work fine.

[byrneh]

Hi @adriangb
A 404 Not Found from a REST API is often returned due to insufficient permissions (there are security reasons why its a 404, but the explanation is outside the scope of this question)

I was able GET with a Token scoped “repo” (Full control of private repositories) for one of my own Pages.
https://api.github.com/repos/octocat/hello-world/pages returns a 404 Not Found for me also.

Your “gh-pages-docs” is retrievable, when I tried

[prem-mukherji]

For me, it was my organization permissions, where it was asking to enable the SSO. I did and it worked.
Thank You.

[adriangb]

Thanks for testing @byrneh

I can confirm that using a repo-scoped token I am able to get a response.

That begs the question: why is auth required to hit this GET endpoint for public repos, when one can hit many other GET endpoints on public repos (e.g. GET /repos/{owner}/{repo} or GET /repos/{owner}/{repo}/tags) without authenticating. Is there some permissions/security issue I’m not thinking of that requires this behavior? It seems to me that for public repos, any info that is accessible without authenticating on github.com should be available without authenticating via API.

Regardless, it seems that octocat/hello-world does not have pages configured, so that should be fixed or the docs should be changed.

[ReenigneArcher]

A year later and still seems to be an issue. Docs were updated, but the new example still doesn't work (with or without the repo scope).

My initial thought was the endpoint only works for repos owned by the token user, but that doesn't seem to be the case as I can get pages info for other public repos, so long as the repo scope is added to the token. The docs still don't make any mention of the token scope for the "GET" method.

Anyway, thanks to your comment I was able to solve my issue.

[monikacp]

How you solved this issue? I am still facing 404 error.

[ReenigneArcher]

Add "repo" scope to your PAT, and make sure you authenticate.

[byrneh]

@adriangb, I guess it could equally be argued why would authorization not be required, I am not defending one position or the other on this matter…
I did notice the API returns the details of GitHub pages and these can be public or private, so an authentication header does not some unreasonable to determine whether the requestor is authorised to receive the result of a Private GitHub Page.

If you are happy your original question is now solved, you can mark as resolved.

[adriangb]

Thank you for the answer. I’ll mark your answer as a solution, although I still think that the following should be done

1. The documentation or example repo are fixed.
2. A clear explanation is given regarding the permissions for this endpoint.

[byrneh]

I would agree in some cases the documentation does do not detail a lot of extra information other than the fields and whether it needs to be authenticated or not, so the addition of minimum scope permissions is useful to avoid users having to work out for themselves and also not get confused that a 404 Not Found may be the result of incorrectly scoped permissions.
I would also agree it is less confusing for a user reading docs if any example shown works.

[apertureatf1]

Hi, Byrneh
First, I have a similar issue. I am able to read repos by using a token.

Second, I am also able to add collaborators use the same token

https://api.github.com/repos/apertureqa/new_repo/collaborators/apertureatf1

however, when I try to upload a file to the same repo. I got not found error error code 404. I guess it is related with privilege? what should I do manually to change the file test priviliage to allow additional content can be add to test. I manuall created the following file in the repo. what kinds of permission I need to manually update on this file to allow the API call PUT go though to add content to the file? thank you very much

I have been blocked, it will be

‘https://api.github.com/repos/apertureqa/new_repo/test’

[byrneh]

Hi @apertureatf1,
This is not really a similar issue, It is best practise and helps all involved greatly with readability and understanding and for others to support you by creating new issues/questions specific to your problems, rather than various different threads of one issues, it gets messy and confusing.
Don’t worry people in the community will still help resolve any issues in your new thread.
you can also mention a user with an '@'followed by their name.

Your question is not altogether clear, but if I was to guess it sounds like you are trying to use the REST api incorrectly, user will work with git client/GUI’s for updating content.
Any action possible through the REST api is documented here GitHub REST API - GitHub Docs.
If you are a new year the simplest thing to do is follow one of the quick guided tutorials.
If you head over to GitHub’s GitHub Learning Lab and Introduction to GitHub’ should get you started using GitHub in less than an hour.
I have found a lot of occasional users now using GitHub Desktop or similar GUIs see Getting started with GitHub Desktop - GitHub Docs, it avoids the need to know and remember a lot of command line syntax etc.

I also tried the REST API method for create-or-update-file-contents if that is what you were attempting

• accidentally using GET rather than PUT IN HTTP verb returns status 404 Not Found
• content Base64 encoded and using PUT I got status 422 “message”: “content is not valid Base64”,
• The same content again but converted using with Base64 with padding and it worked status 201
  I was able to update content with PUT and delete with DELETE

Good luck

[fceller]

I have a token that has all “repo” entries, but I’m still getting 404. Any idea what could be this issue in this case

> curl -X GET -H "Accept: application/vnd.github.v3+json" -H "Authorization: $GITHUB_TOKEN" https://api.github.com/repos/arangodb/justfortesting/pages
{
  "message": "Not Found",
  "documentation_url": "https://docs.github.com/rest/reference/repos#get-a-github-pages-site"
}

[brooookemiller]

I was facing the same issue and updated my personal access token to include all of the scopes selected under "repo", which did the trick for me. I previously only had selected:

• repo:status Access commit status
• public_repo Access public repositories

but it seems that the other repo scope selections were needed. I would highly suggest clarifying this scope need in the docs.

[guenan01]

This was my solution. I was trying to use fine grained tokens at first but failing. I had to use classic tokens, include ALL repo checkboxes, and then Configure SSO once the token was generated. I don't see an obvious way to configure SSO authorization with fine grained tokens.

[aeonian-joy]

I'm facing 404 Not Found messages while creating a repo using postman. I have an PAT and the same I am using for GET request, and it is giving me 200 OK but same is failing while POST method. Why so?

[riverdusty]

This is still a problem. Docs say "no additional permissions". New BETA token creator set to 'All repositories' and 'Repository permissions = issues = read only access'... Generated token. Still get 404 on GET repos/USER/REPO/issues. (The repo is a private repo)

Its clear, if I'm doing something wrong, its because its not covered in the documentation.

[Andrewdddobusiness]

any update to this? im hitting the same issue

[boctulus]

Same problem here in 2024 with different kind of tokens.

[monikacp]

Thank you. It's working for me. Best Regards, Monika Sahu DevOps Engineer c. +91 8827305731 e. ***@***.*** Cloudphysician Healthcare Private Limited 7, Bellary Road, Ganganagar Bengaluru, 560032, KA, India. cloudphysician.net <http://www.cloudphysician.net>

…

On Thu, Apr 4, 2024 at 11:27 PM guenan01 ***@***.***> wrote: This was my solution. I was trying to use fine grained tokens at first but failing. I had to use classic tokens, include ALL repo checkboxes, and then Configure SSO once the token was generated. I don't see an obvious way to configure SSO authorization with fine grained tokens. — Reply to this email directly, view it on GitHub <#24604 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A2VQPDBAHAOOKXVO5WHI7GLY3WIBJAVCNFSM545WWM52U5DIOJSWCZC7NNSXTOKENFZWG5LTONUW63SDN5WW2ZLOOQ5TSMBRGI4TMNA> . You are receiving this because you commented.Message ID: ***@***.***>