Skip to main content

Enterprise Server 3.15 is currently available as a release candidate.

The REST API is now versioned. For more information, see "About API versioning."

REST API endpoints for feeds

Use the REST API to interact with GitHub feeds.

Get feeds

Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

  • Timeline: The GitHub Enterprise Server global public timeline
  • User: The public timeline for any user, using uri_template. For more information, see "Hypermedia."
  • Current user public: The public timeline for the authenticated user
  • Current user: The private timeline for the authenticated user
  • Current user actor: The private timeline for activity created by the authenticated user
  • Current user organizations: The private timeline for the organizations the authenticated user is a member of.
  • Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.

By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see "Media types."

Note

Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

Fine-grained access tokens for "Get feeds"

This endpoint works with the following fine-grained token types:

The fine-grained token does not require any permissions.

HTTP response status codes for "Get feeds"

Status codeDescription
200

OK

Code samples for "Get feeds"

Request example

get/feeds
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/feeds

Response

Status: 200
{ "timeline_url": "https://github.com/timeline", "user_url": "https://github.com/{user}", "current_user_public_url": "https://github.com/octocat", "current_user_url": "https://github.com/octocat.private?token=abc123", "current_user_actor_url": "https://github.com/octocat.private.actor?token=abc123", "current_user_organization_url": "", "current_user_organization_urls": [ "https://github.com/organizations/github/octocat.private.atom?token=abc123" ], "security_advisories_url": "https://github.com/security-advisories", "_links": { "timeline": { "href": "https://github.com/timeline", "type": "application/atom+xml" }, "user": { "href": "https://github.com/{user}", "type": "application/atom+xml" }, "current_user_public": { "href": "https://github.com/octocat", "type": "application/atom+xml" }, "current_user": { "href": "https://github.com/octocat.private?token=abc123", "type": "application/atom+xml" }, "current_user_actor": { "href": "https://github.com/octocat.private.actor?token=abc123", "type": "application/atom+xml" }, "current_user_organization": { "href": "", "type": "" }, "current_user_organizations": [ { "href": "https://github.com/organizations/github/octocat.private.atom?token=abc123", "type": "application/atom+xml" } ] } }