GitHub API

Base url https://api.github.com/


Version v3


Security


oauth_2_0

OAuth2 is a protocol that lets external apps request authorization to private details in a user's GitHub account without getting their password. This is preferred over Basic Authentication because tokens can be limited to specific types of data, and can be revoked by users at any time.

oauth_2_0

Request


Query parameters
  • access_token (string )
    Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

Headers
  • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
    • Response

    • Http Status code
      404
      Unauthorized
    • Settings

    • Authorization Uri: https://github.com/login/oauth/authorize
    • Access Token Uri: https://github.com/login/oauth/access_token
    • Authorization Grants

      • code
    • Scopes

      • user
      • user:email
      • user:follow
      • public_repo
      • repo
      • repo:status
      • delete_repo
      • notifications
      • gist

    Resources

    URl: /search

    URl: /search/repositories

    GET
    /search/repositories
    Description

    Search repositories.

    Request


    Query parameters
    • q (string )
      The search terms. This can be any combination of the supported repository search parameters: 'Search In' Qualifies which fields are searched. With this qualifier you can restrict the search to just the repository name, description, readme, or any combination of these. 'Size' Finds repositories that match a certain size (in kilobytes). 'Forks' Filters repositories based on the number of forks, and/or whether forked repositories should be included in the results at all. 'Created' and 'Last Updated' Filters repositories based on times of creation, or when they were last updated. 'Users or Repositories' Limits searches to a specific user or repository. 'Languages' Searches repositories based on the language they're written in. 'Stars' Searches repositories based on the number of stars.
    • sort (string )
      If not provided, results are sorted by best match.
    • order (string )
      • Response

      • Http Status code
        200
      • Content-Type: application/json
      • Example
        Schema
      URl: /search/code

      GET
      /search/code
      Description

      Search code.

      Request


      Query parameters
      • q (string )
        The search terms. This can be any combination of the supported code search parameters: 'Search In' Qualifies which fields are searched. With this qualifier you can restrict the search to just the file contents, the file path, or both. 'Languages' Searches code based on the language it's written in. 'Forks' Filters repositories based on the number of forks, and/or whether code from forked repositories should be included in the results at all. 'Size' Finds files that match a certain size (in bytes). 'Path' Specifies the path that the resulting file must be at. 'Extension' Matches files with a certain extension. 'Users' or 'Repositories' Limits searches to a specific user or repository.
      • sort (string )
        Can only be 'indexed', which indicates how recently a file has been indexed by the GitHub search infrastructure. If not provided, results are sorted by best match.
      • order (string )
        • Response

        • Http Status code
          200
        • Content-Type: application/json
        • Example
          Schema
        URl: /search/users

        GET
        /search/users
        Description

        Search users.

        Request


        Query parameters
        • q (string )
          The search terms. This can be any combination of the supported user search parameters: 'Search In' Qualifies which fields are searched. With this qualifier you can restrict the search to just the username, public email, full name, location, or any combination of these. 'Repository count' Filters users based on the number of repositories they have. 'Location' Filter users by the location indicated in their profile. 'Language' Search for users that have repositories that match a certain language. 'Created' Filter users based on when they joined. 'Followers' Filter users based on the number of followers they have.
        • sort (string )
          If not provided, results are sorted by best match.
        • order (string )
          • Response

          • Http Status code
            200
          • Content-Type: application/json
          • Example
            Schema
          URl: /events

          GET
          /events
          Description

          List public events.

          Request

            • Response

            • Http Status code
              200
            • Content-Type: application/json
            • Example
              Schema
            URl: /feeds

            GET
            /feeds
            Description

            List Feeds. GitHub provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticating user.

            Request

              • Response

              • Http Status code
                200
              • Content-Type: application/json
              • Example
                Schema
              URl: /meta

              GET
              /meta
              Description

              This gives some information about GitHub.com, the service.

              Request

                • Response

                • Http Status code
                  200
                • Content-Type: application/json
                • Example
                  Schema
                URl: /rate_limit

                GET
                /rate_limit
                Description

                Get your current rate limit status Note: Accessing this endpoint does not count against your rate limit.

                Request

                  • Response

                  • Http Status code
                    200
                  • Content-Type: application/json
                  • Example
                    Schema
                  URl: /issues

                  GET
                  /issues
                  Description

                  List issues. List all issues across all the authenticated user's visible repositories.

                  Request


                  Query parameters
                  • filter (string )
                    Issues assigned to you / created by you / mentioning you / you're subscribed to updates for / All issues the authenticated user can see
                  • state (string )
                  • labels (string )
                    String list of comma separated Label names. Example - bug,ui,@high.
                  • sort (string )
                  • direction (string )
                  • since (string )
                    Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only issues updated at or after this time are returned.
                    • Response

                    • Http Status code
                      200
                    • Content-Type: application/json
                    • Example
                      Schema
                    URl: /notifications

                    GET
                    /notifications
                    Description

                    List your notifications. List all notifications for the current user, grouped by repository.

                    Request


                    Query parameters
                    • all (string )
                      True to show notifications marked as read.
                    • participating (string )
                      True to show only notifications in which the user is directly participating or mentioned.
                    • since (string )
                      Time filters out any notifications updated before the given time. The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Example: "2012-10-09T23:39:01Z".
                      • Response

                      • Http Status code
                        200
                      • Content-Type: application/json
                      • Example
                        Schema
                      PUT
                      /notifications
                      Description

                      Mark as read. Marking a notification as "read" removes it from the default view on GitHub.com.

                      Request

                      • Content-Type: application/json
                      • Body
                      • Schema
                      • Response

                      • Http Status code
                        205
                        Marked as read.
                      URl: /notifications/threads/{id}

                      GET
                      /notifications/threads/{id}
                      Description

                      View a single thread.

                      Request


                      Uri Parameters
                      • id (integer )
                        Id of a thread.
                        • Response

                        • Http Status code
                          200
                        • Content-Type: application/json
                        • Example
                          Schema
                        PATCH
                        /notifications/threads/{id}
                        Description

                        Request


                        Uri Parameters
                        • id (integer )
                          Id of a thread.
                          • Response

                          • Http Status code
                            205
                            Thread marked as read.
                          URl: /notifications/threads/{id}/subscription

                          GET
                          /notifications/threads/{id}/subscription
                          Description

                          Get a Thread Subscription.

                          Request


                          Uri Parameters
                          • id (integer )
                            Id of a thread.
                            • Response

                            • Http Status code
                              200
                            • Content-Type: application/json
                            • Example
                              Schema
                            PUT
                            /notifications/threads/{id}/subscription
                            Description

                            Set a Thread Subscription. This lets you subscribe to a thread, or ignore it. Subscribing to a thread is unnecessary if the user is already subscribed to the repository. Ignoring a thread will mute all future notifications (until you comment or get @mentioned).

                            Request


                            Uri Parameters
                            • id (integer )
                              Id of a thread.
                            • Content-Type: application/json
                            • Body
                            • Schema
                            • Response

                            • Http Status code
                              200
                            • Content-Type: application/json
                            • Example
                              Schema
                            DELETE
                            /notifications/threads/{id}/subscription
                            Description

                            Delete a Thread Subscription.

                            Request


                            Uri Parameters
                            • id (integer )
                              Id of a thread.
                              • Response

                              • Http Status code
                                204
                                Item removed.
                              URl: /gists

                              GET
                              /gists
                              Description

                              List the authenticated user's gists or if called anonymously, this will return all public gists.

                              Secured by oauth_2_0

                              Request


                              Query parameters
                              • since (string )
                                Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.
                              • access_token (string )
                                Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                              Headers
                              • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                • Response

                                • Http Status code
                                  200
                                • Content-Type: application/json
                                • Example
                                  Schema
                                • Http Status code
                                  404
                                  Unauthorized
                                POST
                                /gists
                                Description

                                Create a gist.

                                Secured by oauth_2_0

                                Request


                                Query parameters
                                • access_token (string )
                                  Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                Headers
                                • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                • Content-Type: application/json
                                • Body
                                • Schema
                                • Response

                                • Http Status code
                                  201
                                • Content-Type: application/json
                                • Example
                                  Schema
                                • Http Status code
                                  404
                                  Unauthorized
                                URl: /gists/public

                                GET
                                /gists/public
                                Description

                                List all public gists.

                                Secured by oauth_2_0

                                Request


                                Query parameters
                                • since (string )
                                  Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.
                                • access_token (string )
                                  Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                Headers
                                • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                  • Response

                                  • Http Status code
                                    200
                                  • Content-Type: application/json
                                  • Example
                                    Schema
                                  • Http Status code
                                    404
                                    Unauthorized
                                  URl: /gists/starred

                                  GET
                                  /gists/starred
                                  Description

                                  List the authenticated user's starred gists.

                                  Secured by oauth_2_0

                                  Request


                                  Query parameters
                                  • since (string )
                                    Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.
                                  • access_token (string )
                                    Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                  Headers
                                  • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                    • Response

                                    • Http Status code
                                      200
                                    • Content-Type: application/json
                                    • Example
                                      Schema
                                    • Http Status code
                                      404
                                      Unauthorized
                                    URl: /gists/{id}

                                    GET
                                    /gists/{id}
                                    Description

                                    Get a single gist.

                                    Secured by oauth_2_0

                                    Request


                                    Uri Parameters
                                    • id (integer )
                                      Id of a thread.

                                    Query parameters
                                    • access_token (string )
                                      Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                    Headers
                                    • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                      • Response

                                      • Http Status code
                                        200
                                      • Content-Type: application/json
                                      • Example
                                        Schema
                                      • Http Status code
                                        404
                                        Unauthorized
                                      PATCH
                                      /gists/{id}
                                      Description

                                      Edit a gist.

                                      Secured by oauth_2_0

                                      Request


                                      Uri Parameters
                                      • id (integer )
                                        Id of a thread.

                                      Query parameters
                                      • access_token (string )
                                        Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                      Headers
                                      • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                      • Content-Type: application/json
                                      • Body
                                      • Schema
                                      • Response

                                      • Http Status code
                                        200
                                      • Content-Type: application/json
                                      • Example
                                        Schema
                                      • Http Status code
                                        404
                                        Unauthorized
                                      DELETE
                                      /gists/{id}
                                      Description

                                      Delete a gist.

                                      Secured by oauth_2_0

                                      Request


                                      Uri Parameters
                                      • id (integer )
                                        Id of a thread.

                                      Query parameters
                                      • access_token (string )
                                        Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                      Headers
                                      • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                        • Response

                                        • Http Status code
                                          204
                                          Item removed.
                                        • Http Status code
                                          404
                                          Unauthorized
                                        URl: /gists/{id}/star

                                        GET
                                        /gists/{id}/star
                                        Description

                                        Check if a gist is starred.

                                        Secured by oauth_2_0

                                        Request


                                        Uri Parameters
                                        • id (integer )
                                          Id of a thread.

                                        Query parameters
                                        • access_token (string )
                                          Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                        Headers
                                        • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                        • Accept: Is used to set specified media type.
                                        • X-RateLimit-Limit:
                                        • X-RateLimit-Remaining:
                                        • X-RateLimit-Reset:
                                        • X-GitHub-Request-Id:
                                        • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                          • Response

                                          • Http Status code
                                            403
                                            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                          • Http Status code
                                            204
                                            Exists.
                                          • Http Status code
                                            404
                                            Unauthorized
                                          PUT
                                          /gists/{id}/star
                                          Description

                                          Star a gist.

                                          Secured by oauth_2_0

                                          Request


                                          Uri Parameters
                                          • id (integer )
                                            Id of a thread.

                                          Query parameters
                                          • access_token (string )
                                            Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                          Headers
                                          • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                          • Accept: Is used to set specified media type.
                                          • X-RateLimit-Limit:
                                          • X-RateLimit-Remaining:
                                          • X-RateLimit-Reset:
                                          • X-GitHub-Request-Id:
                                          • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                            • Response

                                            • Http Status code
                                              403
                                              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                            • Http Status code
                                              204
                                              Starred.
                                            • Http Status code
                                              404
                                              Unauthorized
                                            DELETE
                                            /gists/{id}/star
                                            Description

                                            Unstar a gist.

                                            Secured by oauth_2_0

                                            Request


                                            Uri Parameters
                                            • id (integer )
                                              Id of a thread.

                                            Query parameters
                                            • access_token (string )
                                              Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                            Headers
                                            • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                            • Accept: Is used to set specified media type.
                                            • X-RateLimit-Limit:
                                            • X-RateLimit-Remaining:
                                            • X-RateLimit-Reset:
                                            • X-GitHub-Request-Id:
                                            • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                              • Response

                                              • Http Status code
                                                403
                                                API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                              • Http Status code
                                                204
                                                Item removed.
                                              • Http Status code
                                                404
                                                Unauthorized
                                              URl: /gists/{id}/forks

                                              POST
                                              /gists/{id}/forks
                                              Description

                                              Fork a gist.

                                              Secured by oauth_2_0

                                              Request


                                              Uri Parameters
                                              • id (integer )
                                                Id of a thread.

                                              Query parameters
                                              • access_token (string )
                                                Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                              Headers
                                              • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                              • Accept: Is used to set specified media type.
                                              • X-RateLimit-Limit:
                                              • X-RateLimit-Remaining:
                                              • X-RateLimit-Reset:
                                              • X-GitHub-Request-Id:
                                              • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                                • Response

                                                • Http Status code
                                                  403
                                                  API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                • Http Status code
                                                  204
                                                  Exists.
                                                • Http Status code
                                                  404
                                                  Unauthorized
                                                URl: /gists/{id}/comments

                                                GET
                                                /gists/{id}/comments
                                                Description

                                                List comments on a gist.

                                                Secured by oauth_2_0

                                                Request


                                                Uri Parameters
                                                • id (integer )
                                                  Id of a thread.

                                                Query parameters
                                                • access_token (string )
                                                  Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                                Headers
                                                • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                                  • Response

                                                  • Http Status code
                                                    200
                                                  • Content-Type: application/json
                                                  • Example
                                                    Schema
                                                  • Http Status code
                                                    404
                                                    Unauthorized
                                                  POST
                                                  /gists/{id}/comments
                                                  Description

                                                  Create a comment

                                                  Secured by oauth_2_0

                                                  Request


                                                  Uri Parameters
                                                  • id (integer )
                                                    Id of a thread.

                                                  Query parameters
                                                  • access_token (string )
                                                    Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                                  Headers
                                                  • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                                  • Content-Type: application/json
                                                  • Body
                                                  • Schema
                                                  • Response

                                                  • Http Status code
                                                    201
                                                  • Content-Type: application/json
                                                  • Example
                                                    Schema
                                                  • Http Status code
                                                    404
                                                    Unauthorized
                                                  URl: /gists/{id}/comments/{commentId}

                                                  GET
                                                  /gists/{id}/comments/{commentId}
                                                  Description

                                                  Get a single comment.

                                                  Secured by oauth_2_0

                                                  Request


                                                  Uri Parameters
                                                  • commentId (integer )
                                                    Id of the comment.
                                                  • id (integer )
                                                    Id of a thread.

                                                  Query parameters
                                                  • access_token (string )
                                                    Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                                  Headers
                                                  • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                                    • Response

                                                    • Http Status code
                                                      200
                                                    • Content-Type: application/json
                                                    • Example
                                                      Schema
                                                    • Http Status code
                                                      404
                                                      Unauthorized
                                                    PATCH
                                                    /gists/{id}/comments/{commentId}
                                                    Description

                                                    Edit a comment.

                                                    Secured by oauth_2_0

                                                    Request


                                                    Uri Parameters
                                                    • commentId (integer )
                                                      Id of the comment.
                                                    • id (integer )
                                                      Id of a thread.

                                                    Query parameters
                                                    • access_token (string )
                                                      Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                                    Headers
                                                    • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                                    • Content-Type: application/json
                                                    • Body
                                                    • Schema
                                                    • Response

                                                    • Http Status code
                                                      200
                                                    • Content-Type: application/json
                                                    • Example
                                                      Schema
                                                    • Http Status code
                                                      404
                                                      Unauthorized
                                                    DELETE
                                                    /gists/{id}/comments/{commentId}
                                                    Description

                                                    Delete a comment.

                                                    Secured by oauth_2_0

                                                    Request


                                                    Uri Parameters
                                                    • commentId (integer )
                                                      Id of the comment.
                                                    • id (integer )
                                                      Id of a thread.

                                                    Query parameters
                                                    • access_token (string )
                                                      Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                                    Headers
                                                    • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                                      • Response

                                                      • Http Status code
                                                        204
                                                        Item removed.
                                                      • Http Status code
                                                        404
                                                        Unauthorized
                                                      URl: /orgs/{orgId}

                                                      GET
                                                      /orgs/{orgId}
                                                      Description

                                                      Get an Organization.

                                                      Request


                                                      Uri Parameters
                                                      • orgId (integer )
                                                        Id of organisation.
                                                        • Response

                                                        • Http Status code
                                                          200
                                                        • Content-Type: application/json
                                                        • Example
                                                          Schema
                                                        PATCH
                                                        /orgs/{orgId}
                                                        Description

                                                        Edit an Organization.

                                                        Request


                                                        Uri Parameters
                                                        • orgId (integer )
                                                          Id of organisation.
                                                        • Content-Type: application/json
                                                        • Body
                                                        • Schema
                                                        • Response

                                                        • Http Status code
                                                          200
                                                        • Content-Type: application/json
                                                        • Example
                                                          Schema
                                                        URl: /orgs/{orgId}/events

                                                        GET
                                                        /orgs/{orgId}/events
                                                        Description

                                                        List public events for an organization.

                                                        Request


                                                        Uri Parameters
                                                        • orgId (integer )
                                                          Id of organisation.
                                                          • Response

                                                          • Http Status code
                                                            200
                                                          • Content-Type: application/json
                                                          • Example
                                                            Schema
                                                          URl: /orgs/{orgId}/issues

                                                          GET
                                                          /orgs/{orgId}/issues
                                                          Description

                                                          List issues. List all issues for a given organization for the authenticated user.

                                                          Request


                                                          Uri Parameters
                                                          • orgId (integer )
                                                            Id of organisation.

                                                          Query parameters
                                                          • filter (string )
                                                            Issues assigned to you / created by you / mentioning you / you're subscribed to updates for / All issues the authenticated user can see
                                                          • state (string )
                                                          • labels (string )
                                                            String list of comma separated Label names. Example - bug,ui,@high.
                                                          • sort (string )
                                                          • direction (string )
                                                          • since (string )
                                                            Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only issues updated at or after this time are returned.
                                                            • Response

                                                            • Http Status code
                                                              200
                                                            • Content-Type: application/json
                                                            • Example
                                                              Schema
                                                            URl: /orgs/{orgId}/members

                                                            GET
                                                            /orgs/{orgId}/members
                                                            Description

                                                            Members list. List all users who are members of an organization. A member is a user that belongs to at least 1 team in the organization. If the authenticated user is also an owner of this organization then both concealed and public members will be returned. If the requester is not an owner of the organization the query will be redirected to the public members list.

                                                            Request


                                                            Uri Parameters
                                                            • orgId (integer )
                                                              Id of organisation.
                                                              • Response

                                                              • Http Status code
                                                                200
                                                              • Content-Type: application/json
                                                              • Example
                                                                Schema
                                                              • Http Status code
                                                                302
                                                                Response if requester is not an organization member.
                                                              URl: /orgs/{orgId}/members/{userId}

                                                              DELETE
                                                              /orgs/{orgId}/members/{userId}
                                                              Description

                                                              Remove a member. Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

                                                              Request


                                                              Uri Parameters
                                                              • userId (integer )
                                                                Id of the user.
                                                              • orgId (integer )
                                                                Id of organisation.
                                                                • Response

                                                                • Http Status code
                                                                  204
                                                                  Item removed.
                                                                URl: /orgs/{orgId}/public_members

                                                                GET
                                                                /orgs/{orgId}/public_members
                                                                Description

                                                                Public members list. Members of an organization can choose to have their membership publicized or not.

                                                                Request


                                                                Uri Parameters
                                                                • orgId (integer )
                                                                  Id of organisation.
                                                                  • Response

                                                                  • Http Status code
                                                                    200
                                                                  • Content-Type: application/json
                                                                  • Example
                                                                    Schema
                                                                  URl: /orgs/{orgId}/public_members/{userId}

                                                                  GET
                                                                  /orgs/{orgId}/public_members/{userId}
                                                                  Description

                                                                  Check public membership.

                                                                  Request


                                                                  Uri Parameters
                                                                  • userId (integer )
                                                                    Id of the user.
                                                                  • orgId (integer )
                                                                    Id of organisation.

                                                                  Headers
                                                                  • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                  • Accept: Is used to set specified media type.
                                                                  • X-RateLimit-Limit:
                                                                  • X-RateLimit-Remaining:
                                                                  • X-RateLimit-Reset:
                                                                  • X-GitHub-Request-Id:
                                                                    • Response

                                                                    • Http Status code
                                                                      403
                                                                      API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                    • Http Status code
                                                                      204
                                                                      User is a public member.
                                                                    • Http Status code
                                                                      404
                                                                      User is not a public member.
                                                                    PUT
                                                                    /orgs/{orgId}/public_members/{userId}
                                                                    Description

                                                                    Publicize a user's membership.

                                                                    Request


                                                                    Uri Parameters
                                                                    • userId (integer )
                                                                      Id of the user.
                                                                    • orgId (integer )
                                                                      Id of organisation.

                                                                    Headers
                                                                    • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                    • Accept: Is used to set specified media type.
                                                                    • X-RateLimit-Limit:
                                                                    • X-RateLimit-Remaining:
                                                                    • X-RateLimit-Reset:
                                                                    • X-GitHub-Request-Id:
                                                                      • Response

                                                                      • Http Status code
                                                                        403
                                                                        API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                      • Http Status code
                                                                        204
                                                                        Publicized.
                                                                      DELETE
                                                                      /orgs/{orgId}/public_members/{userId}
                                                                      Description

                                                                      Conceal a user's membership.

                                                                      Request


                                                                      Uri Parameters
                                                                      • userId (integer )
                                                                        Id of the user.
                                                                      • orgId (integer )
                                                                        Id of organisation.

                                                                      Headers
                                                                      • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                      • Accept: Is used to set specified media type.
                                                                      • X-RateLimit-Limit:
                                                                      • X-RateLimit-Remaining:
                                                                      • X-RateLimit-Reset:
                                                                      • X-GitHub-Request-Id:
                                                                        • Response

                                                                        • Http Status code
                                                                          403
                                                                          API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                        • Http Status code
                                                                          204
                                                                          Concealed.
                                                                        URl: /orgs/{orgId}/teams

                                                                        GET
                                                                        /orgs/{orgId}/teams
                                                                        Description

                                                                        List teams.

                                                                        Request


                                                                        Uri Parameters
                                                                        • orgId (integer )
                                                                          Id of organisation.
                                                                          • Response

                                                                          • Http Status code
                                                                            200
                                                                          • Content-Type: application/json
                                                                          • Example
                                                                            Schema
                                                                          POST
                                                                          /orgs/{orgId}/teams
                                                                          Description

                                                                          Create team. In order to create a team, the authenticated user must be an owner of orgId.

                                                                          Request


                                                                          Uri Parameters
                                                                          • orgId (integer )
                                                                            Id of organisation.
                                                                          • Content-Type: application/json
                                                                          • Body
                                                                          • Schema
                                                                          • Response

                                                                          • Http Status code
                                                                            201
                                                                          • Content-Type: application/json
                                                                          • Example
                                                                            Schema
                                                                          URl: /orgs/{orgId}/repos

                                                                          GET
                                                                          /orgs/{orgId}/repos
                                                                          Description

                                                                          List repositories for the specified org.

                                                                          Request


                                                                          Uri Parameters
                                                                          • orgId (integer )
                                                                            Id of organisation.

                                                                          Query parameters
                                                                          • type (string )
                                                                            • Response

                                                                            • Http Status code
                                                                              200
                                                                            • Content-Type: application/json
                                                                            • Example
                                                                              Schema
                                                                            POST
                                                                            /orgs/{orgId}/repos
                                                                            Description

                                                                            Create a new repository for the authenticated user. OAuth users must supply repo scope.

                                                                            Request


                                                                            Uri Parameters
                                                                            • orgId (integer )
                                                                              Id of organisation.
                                                                            • Content-Type: application/json
                                                                            • Body
                                                                            • Schema
                                                                            • Response

                                                                            • Http Status code
                                                                              201
                                                                            • Content-Type: application/json
                                                                            • Example
                                                                              Schema
                                                                            URl: /teams/{teamsId}

                                                                            GET
                                                                            /teams/{teamsId}
                                                                            Description

                                                                            Get team.

                                                                            Request


                                                                            Uri Parameters
                                                                            • teamsId (integer )
                                                                              Id of a team.
                                                                              • Response

                                                                              • Http Status code
                                                                                200
                                                                              • Content-Type: application/json
                                                                              • Example
                                                                                Schema
                                                                              PATCH
                                                                              /teams/{teamsId}
                                                                              Description

                                                                              Edit team. In order to edit a team, the authenticated user must be an owner of the org that the team is associated with.

                                                                              Request


                                                                              Uri Parameters
                                                                              • teamsId (integer )
                                                                                Id of a team.
                                                                              • Content-Type: application/json
                                                                              • Body
                                                                              • Schema
                                                                              • Response

                                                                              • Http Status code
                                                                                200
                                                                              • Content-Type: application/json
                                                                              • Example
                                                                                Schema
                                                                              DELETE
                                                                              /teams/{teamsId}
                                                                              Description

                                                                              Delete team. In order to delete a team, the authenticated user must be an owner of the org that the team is associated with.

                                                                              Request


                                                                              Uri Parameters
                                                                              • teamsId (integer )
                                                                                Id of a team.
                                                                                • Response

                                                                                • Http Status code
                                                                                  204
                                                                                  Item removed.
                                                                                URl: /teams/{teamsId}/members

                                                                                GET
                                                                                /teams/{teamsId}/members
                                                                                Description

                                                                                List team members. In order to list members in a team, the authenticated user must be a member of the team.

                                                                                Request


                                                                                Uri Parameters
                                                                                • teamsId (integer )
                                                                                  Id of a team.
                                                                                  • Response

                                                                                  • Http Status code
                                                                                    200
                                                                                  • Content-Type: application/json
                                                                                  • Example
                                                                                    Schema
                                                                                  URl: /teams/{teamsId}/members/{userId}

                                                                                  GET
                                                                                  /teams/{teamsId}/members/{userId}
                                                                                  Description

                                                                                  Get team member. In order to get if a user is a member of a team, the authenticated user must be a member of the team.

                                                                                  Request


                                                                                  Uri Parameters
                                                                                  • userId (integer )
                                                                                    Id of a member.
                                                                                  • teamsId (integer )
                                                                                    Id of a team.

                                                                                  Headers
                                                                                  • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                                  • Accept: Is used to set specified media type.
                                                                                  • X-RateLimit-Limit:
                                                                                  • X-RateLimit-Remaining:
                                                                                  • X-RateLimit-Reset:
                                                                                  • X-GitHub-Request-Id:
                                                                                    • Response

                                                                                    • Http Status code
                                                                                      403
                                                                                      API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                                    • Http Status code
                                                                                      204
                                                                                      User is a member.
                                                                                    • Http Status code
                                                                                      404
                                                                                      User is not a member.
                                                                                    PUT
                                                                                    /teams/{teamsId}/members/{userId}
                                                                                    Description

                                                                                    Add team member. In order to add a user to a team, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with.

                                                                                    Request


                                                                                    Uri Parameters
                                                                                    • userId (integer )
                                                                                      Id of a member.
                                                                                    • teamsId (integer )
                                                                                      Id of a team.

                                                                                    Headers
                                                                                    • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                                    • Accept: Is used to set specified media type.
                                                                                    • X-RateLimit-Limit:
                                                                                    • X-RateLimit-Remaining:
                                                                                    • X-RateLimit-Reset:
                                                                                    • X-GitHub-Request-Id:
                                                                                      • Response

                                                                                      • Http Status code
                                                                                        403
                                                                                        API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                                      • Http Status code
                                                                                        204
                                                                                        Team member added.
                                                                                      • Http Status code
                                                                                        422
                                                                                        If you attempt to add an organization to a team, you will get this.
                                                                                      • Content-Type: application/json
                                                                                      • Example
                                                                                        Schema
                                                                                      DELETE
                                                                                      /teams/{teamsId}/members/{userId}
                                                                                      Description

                                                                                      Remove team member. In order to remove a user from a team, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. NOTE This does not delete the user, it just remove them from the team.

                                                                                      Request


                                                                                      Uri Parameters
                                                                                      • userId (integer )
                                                                                        Id of a member.
                                                                                      • teamsId (integer )
                                                                                        Id of a team.

                                                                                      Headers
                                                                                      • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                                      • Accept: Is used to set specified media type.
                                                                                      • X-RateLimit-Limit:
                                                                                      • X-RateLimit-Remaining:
                                                                                      • X-RateLimit-Reset:
                                                                                      • X-GitHub-Request-Id:
                                                                                        • Response

                                                                                        • Http Status code
                                                                                          403
                                                                                          API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                                        • Http Status code
                                                                                          204
                                                                                          Team member removed.
                                                                                        URl: /repositories

                                                                                        GET
                                                                                        /repositories
                                                                                        Description

                                                                                        List all public repositories. This provides a dump of every public repository, in the order that they were created. Note: Pagination is powered exclusively by the since parameter. is the Link header to get the URL for the next page of repositories.

                                                                                        Secured by null
                                                                                        Secured by oauth_2_0

                                                                                        Request


                                                                                        Query parameters
                                                                                        • since (string )
                                                                                          The integer ID of the last Repository that you've seen.
                                                                                        • access_token (string )
                                                                                          Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

                                                                                        Headers
                                                                                        • Authorization: Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.
                                                                                          • Response

                                                                                          • Http Status code
                                                                                            200
                                                                                          • Content-Type: application/json
                                                                                          • Example
                                                                                            Schema
                                                                                          • Http Status code
                                                                                            404
                                                                                            Unauthorized
                                                                                          URl: /repos/{ownerId}/{repoId}

                                                                                          GET
                                                                                          /repos/{ownerId}/{repoId}
                                                                                          Description

                                                                                          Get repository.

                                                                                          Request


                                                                                          Uri Parameters
                                                                                          • ownerId (integer )
                                                                                            Id of the owner.
                                                                                          • repoId (integer )
                                                                                            Id of repository.
                                                                                            • Response

                                                                                            • Http Status code
                                                                                              200
                                                                                            • Content-Type: application/json
                                                                                            • Example
                                                                                              Schema
                                                                                            PATCH
                                                                                            /repos/{ownerId}/{repoId}
                                                                                            Description

                                                                                            Edit repository.

                                                                                            Request


                                                                                            Uri Parameters
                                                                                            • ownerId (integer )
                                                                                              Id of the owner.
                                                                                            • repoId (integer )
                                                                                              Id of repository.
                                                                                            • Content-Type: application/json
                                                                                            • Body
                                                                                            • Schema
                                                                                            • Response

                                                                                            • Http Status code
                                                                                              200
                                                                                            • Content-Type: application/json
                                                                                            • Example
                                                                                              Schema
                                                                                            DELETE
                                                                                            /repos/{ownerId}/{repoId}
                                                                                            Description

                                                                                            Delete a Repository. Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.

                                                                                            Request


                                                                                            Uri Parameters
                                                                                            • ownerId (integer )
                                                                                              Id of the owner.
                                                                                            • repoId (integer )
                                                                                              Id of repository.
                                                                                              • Response

                                                                                              • Http Status code
                                                                                                204
                                                                                                Item removed.
                                                                                              URl: /repos/{ownerId}/{repoId}/events

                                                                                              GET
                                                                                              /repos/{ownerId}/{repoId}/events
                                                                                              Description

                                                                                              Get list of repository events.

                                                                                              Request


                                                                                              Uri Parameters
                                                                                              • ownerId (integer )
                                                                                                Id of the owner.
                                                                                              • repoId (integer )
                                                                                                Id of repository.
                                                                                                • Response

                                                                                                • Http Status code
                                                                                                  200
                                                                                                • Content-Type: application/json
                                                                                                • Example
                                                                                                  Schema
                                                                                                URl: /repos/{ownerId}/{repoId}/languages

                                                                                                GET
                                                                                                /repos/{ownerId}/{repoId}/languages
                                                                                                Description

                                                                                                List languages. List languages for the specified repository. The value on the right of a language is the number of bytes of code written in that language.

                                                                                                Request


                                                                                                Uri Parameters
                                                                                                • ownerId (integer )
                                                                                                  Id of the owner.
                                                                                                • repoId (integer )
                                                                                                  Id of repository.
                                                                                                  • Response

                                                                                                  • Http Status code
                                                                                                    200
                                                                                                  • Content-Type: application/json
                                                                                                  • Example
                                                                                                    Schema
                                                                                                  URl: /repos/{ownerId}/{repoId}/git

                                                                                                  URl: /repos/{ownerId}/{repoId}/git/blobs

                                                                                                  POST
                                                                                                  /repos/{ownerId}/{repoId}/git/blobs
                                                                                                  Description

                                                                                                  Create a Blob.

                                                                                                  Request


                                                                                                  Uri Parameters
                                                                                                  • ownerId (integer )
                                                                                                    Id of the owner.
                                                                                                  • repoId (integer )
                                                                                                    Id of repository.
                                                                                                  • Content-Type: application/json
                                                                                                  • Body
                                                                                                  • Schema
                                                                                                  • Response

                                                                                                  • Http Status code
                                                                                                    201
                                                                                                  • Content-Type: application/json
                                                                                                  • Example
                                                                                                    Schema
                                                                                                  URl: /repos/{ownerId}/{repoId}/git/blobs/{shaCode}

                                                                                                  GET
                                                                                                  /repos/{ownerId}/{repoId}/git/blobs/{shaCode}
                                                                                                  Description

                                                                                                  Get a Blob. Since blobs can be any arbitrary binary data, the input and responses for the blob API takes an encoding parameter that can be either utf-8 or base64. If your data cannot be losslessly sent as a UTF-8 string, you can base64 encode it.

                                                                                                  Request


                                                                                                  Uri Parameters
                                                                                                  • shaCode (string )
                                                                                                    SHA-1 code.
                                                                                                  • ownerId (integer )
                                                                                                    Id of the owner.
                                                                                                  • repoId (integer )
                                                                                                    Id of repository.
                                                                                                    • Response

                                                                                                    • Http Status code
                                                                                                      200
                                                                                                    • Content-Type: application/json
                                                                                                    • Example
                                                                                                      Schema
                                                                                                    URl: /repos/{ownerId}/{repoId}/git/commits

                                                                                                    POST
                                                                                                    /repos/{ownerId}/{repoId}/git/commits
                                                                                                    Description

                                                                                                    Create a Commit.

                                                                                                    Request


                                                                                                    Uri Parameters
                                                                                                    • ownerId (integer )
                                                                                                      Id of the owner.
                                                                                                    • repoId (integer )
                                                                                                      Id of repository.
                                                                                                    • Content-Type: application/json
                                                                                                    • Body
                                                                                                    • Schema
                                                                                                    • Response

                                                                                                    • Http Status code
                                                                                                      201
                                                                                                    • Content-Type: application/json
                                                                                                    • Example
                                                                                                      Schema
                                                                                                    URl: /repos/{ownerId}/{repoId}/git/commits/{shaCode}

                                                                                                    GET
                                                                                                    /repos/{ownerId}/{repoId}/git/commits/{shaCode}
                                                                                                    Description

                                                                                                    Get a Commit.

                                                                                                    Request


                                                                                                    Uri Parameters
                                                                                                    • shaCode (string )
                                                                                                      SHA-1 code.
                                                                                                    • ownerId (integer )
                                                                                                      Id of the owner.
                                                                                                    • repoId (integer )
                                                                                                      Id of repository.
                                                                                                      • Response

                                                                                                      • Http Status code
                                                                                                        200
                                                                                                      • Content-Type: application/json
                                                                                                      • Example
                                                                                                        Schema
                                                                                                      URl: /repos/{ownerId}/{repoId}/git/refs

                                                                                                      GET
                                                                                                      /repos/{ownerId}/{repoId}/git/refs
                                                                                                      Description

                                                                                                      Get all References

                                                                                                      Request


                                                                                                      Uri Parameters
                                                                                                      • ownerId (integer )
                                                                                                        Id of the owner.
                                                                                                      • repoId (integer )
                                                                                                        Id of repository.
                                                                                                        • Response

                                                                                                        • Http Status code
                                                                                                          200
                                                                                                        • Content-Type: application/json
                                                                                                        • Example
                                                                                                          Schema
                                                                                                        POST
                                                                                                        /repos/{ownerId}/{repoId}/git/refs
                                                                                                        Description

                                                                                                        Create a Reference

                                                                                                        Request


                                                                                                        Uri Parameters
                                                                                                        • ownerId (integer )
                                                                                                          Id of the owner.
                                                                                                        • repoId (integer )
                                                                                                          Id of repository.
                                                                                                        • Content-Type: application/json
                                                                                                        • Body
                                                                                                        • Schema
                                                                                                        • Response

                                                                                                        • Http Status code
                                                                                                          201
                                                                                                        • Content-Type: application/json
                                                                                                        • Example
                                                                                                          Schema
                                                                                                        URl: /repos/{ownerId}/{repoId}/git/refs/{heads}

                                                                                                        GET
                                                                                                        /repos/{ownerId}/{repoId}/git/refs/{heads}
                                                                                                        Description

                                                                                                        Get list of subdirectories.

                                                                                                        Request


                                                                                                        Uri Parameters
                                                                                                        • heads (string )
                                                                                                          Subfolder of path to the branch.
                                                                                                        • ownerId (integer )
                                                                                                          Id of the owner.
                                                                                                        • repoId (integer )
                                                                                                          Id of repository.
                                                                                                          • Response

                                                                                                          • Http Status code
                                                                                                            200
                                                                                                          • Content-Type: application/json
                                                                                                          • Example
                                                                                                            Schema
                                                                                                          URl: /repos/{ownerId}/{repoId}/git/refs/{heads}/{branch}

                                                                                                          GET
                                                                                                          /repos/{ownerId}/{repoId}/git/refs/{heads}/{branch}
                                                                                                          Description

                                                                                                          Get a Reference.

                                                                                                          Request


                                                                                                          Uri Parameters
                                                                                                          • branch (string )
                                                                                                            Path to the branch.
                                                                                                          • heads (string )
                                                                                                            Subfolder of path to the branch.
                                                                                                          • ownerId (integer )
                                                                                                            Id of the owner.
                                                                                                          • repoId (integer )
                                                                                                            Id of repository.
                                                                                                            • Response

                                                                                                            • Http Status code
                                                                                                              200
                                                                                                            • Content-Type: application/json
                                                                                                            • Example
                                                                                                              Schema
                                                                                                            PATCH
                                                                                                            /repos/{ownerId}/{repoId}/git/refs/{heads}/{branch}
                                                                                                            Description

                                                                                                            Update a Reference

                                                                                                            Request


                                                                                                            Uri Parameters
                                                                                                            • branch (string )
                                                                                                              Path to the branch.
                                                                                                            • heads (string )
                                                                                                              Subfolder of path to the branch.
                                                                                                            • ownerId (integer )
                                                                                                              Id of the owner.
                                                                                                            • repoId (integer )
                                                                                                              Id of repository.
                                                                                                            • Content-Type: application/json
                                                                                                            • Body
                                                                                                            • Schema
                                                                                                            • Response

                                                                                                            • Http Status code
                                                                                                              200
                                                                                                            • Content-Type: application/json
                                                                                                            • Example
                                                                                                              Schema
                                                                                                            DELETE
                                                                                                            /repos/{ownerId}/{repoId}/git/refs/{heads}/{branch}
                                                                                                            Description

                                                                                                            Delete a Reference.

                                                                                                            Request


                                                                                                            Uri Parameters
                                                                                                            • branch (string )
                                                                                                              Path to the branch.
                                                                                                            • heads (string )
                                                                                                              Subfolder of path to the branch.
                                                                                                            • ownerId (integer )
                                                                                                              Id of the owner.
                                                                                                            • repoId (integer )
                                                                                                              Id of repository.
                                                                                                              • Response

                                                                                                              • Http Status code
                                                                                                                204
                                                                                                                Item removed.
                                                                                                              URl: /repos/{ownerId}/{repoId}/git/tags

                                                                                                              POST
                                                                                                              /repos/{ownerId}/{repoId}/git/tags
                                                                                                              Description

                                                                                                              Create a Tag Object. Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.

                                                                                                              Request


                                                                                                              Uri Parameters
                                                                                                              • ownerId (integer )
                                                                                                                Id of the owner.
                                                                                                              • repoId (integer )
                                                                                                                Id of repository.
                                                                                                              • Content-Type: application/json
                                                                                                              • Body
                                                                                                              • Schema
                                                                                                              • Response

                                                                                                              • Http Status code
                                                                                                                201
                                                                                                              • Content-Type: application/json
                                                                                                              • Example
                                                                                                                Schema
                                                                                                              URl: /repos/{ownerId}/{repoId}/git/tags/{shaCode}

                                                                                                              GET
                                                                                                              /repos/{ownerId}/{repoId}/git/tags/{shaCode}
                                                                                                              Description

                                                                                                              Get a Tag.

                                                                                                              Request


                                                                                                              Uri Parameters
                                                                                                              • ownerId (integer )
                                                                                                                Id of the owner.
                                                                                                              • repoId (integer )
                                                                                                                Id of repository.
                                                                                                                • Response

                                                                                                                • Http Status code
                                                                                                                  200
                                                                                                                • Content-Type: application/json
                                                                                                                • Example
                                                                                                                  Schema
                                                                                                                URl: /repos/{ownerId}/{repoId}/git/trees

                                                                                                                POST
                                                                                                                /repos/{ownerId}/{repoId}/git/trees
                                                                                                                Description

                                                                                                                Create a Tree. The tree creation API will take nested entries as well. If both a tree and a nested path modifying that tree are specified, it will overwrite the contents of that tree with the new path contents and write a new tree out.

                                                                                                                Request


                                                                                                                Uri Parameters
                                                                                                                • ownerId (integer )
                                                                                                                  Id of the owner.
                                                                                                                • repoId (integer )
                                                                                                                  Id of repository.
                                                                                                                • Content-Type: application/json
                                                                                                                • Body
                                                                                                                • Schema
                                                                                                                • Response

                                                                                                                • Http Status code
                                                                                                                  201
                                                                                                                • Content-Type: application/json
                                                                                                                • Example
                                                                                                                  Schema
                                                                                                                URl: /repos/{ownerId}/{repoId}/git/trees/{shaCode}

                                                                                                                GET
                                                                                                                /repos/{ownerId}/{repoId}/git/trees/{shaCode}
                                                                                                                Description

                                                                                                                Get a Tree.

                                                                                                                Request


                                                                                                                Uri Parameters
                                                                                                                • shaCode (integer )
                                                                                                                  Id of the owner.
                                                                                                                • ownerId (integer )
                                                                                                                  Id of the owner.
                                                                                                                • repoId (integer )
                                                                                                                  Id of repository.

                                                                                                                Query parameters
                                                                                                                • recursive (integer )
                                                                                                                  Get a Tree Recursively. (0 or 1)
                                                                                                                  • Response

                                                                                                                  • Http Status code
                                                                                                                    200
                                                                                                                  • Content-Type: application/json
                                                                                                                  • Example
                                                                                                                    Schema
                                                                                                                  URl: /repos/{ownerId}/{repoId}/readme

                                                                                                                  GET
                                                                                                                  /repos/{ownerId}/{repoId}/readme
                                                                                                                  Description

                                                                                                                  Get the README. This method returns the preferred README for a repository.

                                                                                                                  Request


                                                                                                                  Uri Parameters
                                                                                                                  • ownerId (integer )
                                                                                                                    Id of the owner.
                                                                                                                  • repoId (integer )
                                                                                                                    Id of repository.

                                                                                                                  Query parameters
                                                                                                                  • ref (string )
                                                                                                                    The String name of the Commit/Branch/Tag. Defaults to master.
                                                                                                                    • Response

                                                                                                                    • Http Status code
                                                                                                                      200
                                                                                                                    • Content-Type: application/json
                                                                                                                    • Example
                                                                                                                      Schema
                                                                                                                    URl: /repos/{ownerId}/{repoId}/stargazers

                                                                                                                    GET
                                                                                                                    /repos/{ownerId}/{repoId}/stargazers
                                                                                                                    Description

                                                                                                                    List Stargazers.

                                                                                                                    Request


                                                                                                                    Uri Parameters
                                                                                                                    • ownerId (integer )
                                                                                                                      Id of the owner.
                                                                                                                    • repoId (integer )
                                                                                                                      Id of repository.
                                                                                                                      • Response

                                                                                                                      • Http Status code
                                                                                                                        200
                                                                                                                      • Content-Type: application/json
                                                                                                                      • Example
                                                                                                                        Schema
                                                                                                                      URl: /repos/{ownerId}/{repoId}/subscribers

                                                                                                                      GET
                                                                                                                      /repos/{ownerId}/{repoId}/subscribers
                                                                                                                      Description

                                                                                                                      List watchers.

                                                                                                                      Request


                                                                                                                      Uri Parameters
                                                                                                                      • ownerId (integer )
                                                                                                                        Id of the owner.
                                                                                                                      • repoId (integer )
                                                                                                                        Id of repository.
                                                                                                                        • Response

                                                                                                                        • Http Status code
                                                                                                                          200
                                                                                                                        • Content-Type: application/json
                                                                                                                        • Example
                                                                                                                          Schema
                                                                                                                        URl: /repos/{ownerId}/{repoId}/tags

                                                                                                                        GET
                                                                                                                        /repos/{ownerId}/{repoId}/tags
                                                                                                                        Description

                                                                                                                        Get list of tags.

                                                                                                                        Request


                                                                                                                        Uri Parameters
                                                                                                                        • ownerId (integer )
                                                                                                                          Id of the owner.
                                                                                                                        • repoId (integer )
                                                                                                                          Id of repository.
                                                                                                                          • Response

                                                                                                                          • Http Status code
                                                                                                                            200
                                                                                                                          • Content-Type: application/json
                                                                                                                          • Example
                                                                                                                            Schema
                                                                                                                          URl: /repos/{ownerId}/{repoId}/teams

                                                                                                                          GET
                                                                                                                          /repos/{ownerId}/{repoId}/teams
                                                                                                                          Description

                                                                                                                          Get list of teams

                                                                                                                          Request


                                                                                                                          Uri Parameters
                                                                                                                          • ownerId (integer )
                                                                                                                            Id of the owner.
                                                                                                                          • repoId (integer )
                                                                                                                            Id of repository.
                                                                                                                            • Response

                                                                                                                            • Http Status code
                                                                                                                              200
                                                                                                                            • Content-Type: application/json
                                                                                                                            • Example
                                                                                                                              Schema
                                                                                                                            URl: /repos/{ownerId}/{repoId}/watchers

                                                                                                                            GET
                                                                                                                            /repos/{ownerId}/{repoId}/watchers
                                                                                                                            Description

                                                                                                                            List Stargazers. New implementation.

                                                                                                                            Request


                                                                                                                            Uri Parameters
                                                                                                                            • ownerId (integer )
                                                                                                                              Id of the owner.
                                                                                                                            • repoId (integer )
                                                                                                                              Id of repository.
                                                                                                                              • Response

                                                                                                                              • Http Status code
                                                                                                                                200
                                                                                                                              • Content-Type: application/json
                                                                                                                              • Example
                                                                                                                                Schema
                                                                                                                              URl: /repos/{ownerId}/{repoId}/contributors

                                                                                                                              GET
                                                                                                                              /repos/{ownerId}/{repoId}/contributors
                                                                                                                              Description

                                                                                                                              Get list of contributors.

                                                                                                                              Request


                                                                                                                              Uri Parameters
                                                                                                                              • ownerId (integer )
                                                                                                                                Id of the owner.
                                                                                                                              • repoId (integer )
                                                                                                                                Id of repository.

                                                                                                                              Query parameters
                                                                                                                              • anon (string )
                                                                                                                                Set to 1 or true to include anonymous contributors in results.
                                                                                                                                • Response

                                                                                                                                • Http Status code
                                                                                                                                  200
                                                                                                                                • Content-Type: application/json
                                                                                                                                • Example
                                                                                                                                  Schema
                                                                                                                                URl: /repos/{ownerId}/{repoId}/branches

                                                                                                                                GET
                                                                                                                                /repos/{ownerId}/{repoId}/branches
                                                                                                                                Description

                                                                                                                                Get list of branches

                                                                                                                                Request


                                                                                                                                Uri Parameters
                                                                                                                                • ownerId (integer )
                                                                                                                                  Id of the owner.
                                                                                                                                • repoId (integer )
                                                                                                                                  Id of repository.
                                                                                                                                  • Response

                                                                                                                                  • Http Status code
                                                                                                                                    200
                                                                                                                                  • Content-Type: application/json
                                                                                                                                  • Example
                                                                                                                                    Schema
                                                                                                                                  URl: /repos/{ownerId}/{repoId}/branches/{branchId}

                                                                                                                                  GET
                                                                                                                                  /repos/{ownerId}/{repoId}/branches/{branchId}
                                                                                                                                  Description

                                                                                                                                  Get Branch

                                                                                                                                  Request


                                                                                                                                  Uri Parameters
                                                                                                                                  • branchId (integer )
                                                                                                                                    Id of the branch.
                                                                                                                                  • ownerId (integer )
                                                                                                                                    Id of the owner.
                                                                                                                                  • repoId (integer )
                                                                                                                                    Id of repository.
                                                                                                                                    • Response

                                                                                                                                    • Http Status code
                                                                                                                                      200
                                                                                                                                    • Content-Type: application/json
                                                                                                                                    • Example
                                                                                                                                      Schema
                                                                                                                                    URl: /repos/{ownerId}/{repoId}/issues

                                                                                                                                    GET
                                                                                                                                    /repos/{ownerId}/{repoId}/issues
                                                                                                                                    Description

                                                                                                                                    List issues for a repository.

                                                                                                                                    Request


                                                                                                                                    Uri Parameters
                                                                                                                                    • ownerId (integer )
                                                                                                                                      Id of the owner.
                                                                                                                                    • repoId (integer )
                                                                                                                                      Id of repository.

                                                                                                                                    Query parameters
                                                                                                                                    • filter (string )
                                                                                                                                      Issues assigned to you / created by you / mentioning you / you're subscribed to updates for / All issues the authenticated user can see
                                                                                                                                    • state (string )
                                                                                                                                    • labels (string )
                                                                                                                                      String list of comma separated Label names. Example - bug,ui,@high.
                                                                                                                                    • sort (string )
                                                                                                                                    • direction (string )
                                                                                                                                    • since (string )
                                                                                                                                      Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only issues updated at or after this time are returned.
                                                                                                                                      • Response

                                                                                                                                      • Http Status code
                                                                                                                                        200
                                                                                                                                      • Content-Type: application/json
                                                                                                                                      • Example
                                                                                                                                        Schema
                                                                                                                                      POST
                                                                                                                                      /repos/{ownerId}/{repoId}/issues
                                                                                                                                      Description

                                                                                                                                      Create an issue. Any user with pull access to a repository can create an issue.

                                                                                                                                      Request


                                                                                                                                      Uri Parameters
                                                                                                                                      • ownerId (integer )
                                                                                                                                        Id of the owner.
                                                                                                                                      • repoId (integer )
                                                                                                                                        Id of repository.
                                                                                                                                      • Content-Type: application/json
                                                                                                                                      • Body
                                                                                                                                      • Schema
                                                                                                                                      • Response

                                                                                                                                      • Http Status code
                                                                                                                                        201
                                                                                                                                      • Content-Type: application/json
                                                                                                                                      • Example
                                                                                                                                        Schema
                                                                                                                                      URl: /repos/{ownerId}/{repoId}/issues/events

                                                                                                                                      GET
                                                                                                                                      /repos/{ownerId}/{repoId}/issues/events
                                                                                                                                      Description

                                                                                                                                      List issue events for a repository.

                                                                                                                                      Request


                                                                                                                                      Uri Parameters
                                                                                                                                      • ownerId (integer )
                                                                                                                                        Id of the owner.
                                                                                                                                      • repoId (integer )
                                                                                                                                        Id of repository.
                                                                                                                                        • Response

                                                                                                                                        • Http Status code
                                                                                                                                          200
                                                                                                                                        • Content-Type: application/json
                                                                                                                                        • Example
                                                                                                                                          Schema
                                                                                                                                        URl: /repos/{ownerId}/{repoId}/issues/events/{eventId}

                                                                                                                                        GET
                                                                                                                                        /repos/{ownerId}/{repoId}/issues/events/{eventId}
                                                                                                                                        Description

                                                                                                                                        Get a single event.

                                                                                                                                        Request


                                                                                                                                        Uri Parameters
                                                                                                                                        • eventId (integer )
                                                                                                                                          Id of the event.
                                                                                                                                        • ownerId (integer )
                                                                                                                                          Id of the owner.
                                                                                                                                        • repoId (integer )
                                                                                                                                          Id of repository.
                                                                                                                                          • Response

                                                                                                                                          • Http Status code
                                                                                                                                            200
                                                                                                                                          • Content-Type: application/json
                                                                                                                                          • Example
                                                                                                                                            Schema
                                                                                                                                          URl: /repos/{ownerId}/{repoId}/issues/{number}

                                                                                                                                          GET
                                                                                                                                          /repos/{ownerId}/{repoId}/issues/{number}
                                                                                                                                          Description

                                                                                                                                          Get a single issue

                                                                                                                                          Request


                                                                                                                                          Uri Parameters
                                                                                                                                          • number (integer )
                                                                                                                                            Id of the issue.
                                                                                                                                          • ownerId (integer )
                                                                                                                                            Id of the owner.
                                                                                                                                          • repoId (integer )
                                                                                                                                            Id of repository.
                                                                                                                                            • Response

                                                                                                                                            • Http Status code
                                                                                                                                              200
                                                                                                                                            • Content-Type: application/json
                                                                                                                                            • Example
                                                                                                                                              Schema
                                                                                                                                            PATCH
                                                                                                                                            /repos/{ownerId}/{repoId}/issues/{number}
                                                                                                                                            Description

                                                                                                                                            Edit an issue. Issue owners and users with push access can edit an issue.

                                                                                                                                            Request


                                                                                                                                            Uri Parameters
                                                                                                                                            • number (integer )
                                                                                                                                              Id of the issue.
                                                                                                                                            • ownerId (integer )
                                                                                                                                              Id of the owner.
                                                                                                                                            • repoId (integer )
                                                                                                                                              Id of repository.
                                                                                                                                            • Content-Type: application/json
                                                                                                                                            • Body
                                                                                                                                            • Schema
                                                                                                                                            • Response

                                                                                                                                            • Http Status code
                                                                                                                                              200
                                                                                                                                            • Content-Type: application/json
                                                                                                                                            • Example
                                                                                                                                              Schema
                                                                                                                                            URl: /repos/{ownerId}/{repoId}/issues/{number}/comments

                                                                                                                                            GET
                                                                                                                                            /repos/{ownerId}/{repoId}/issues/{number}/comments
                                                                                                                                            Description

                                                                                                                                            List comments on an issue.

                                                                                                                                            Request


                                                                                                                                            Uri Parameters
                                                                                                                                            • number (integer )
                                                                                                                                              Id of the issue.
                                                                                                                                            • ownerId (integer )
                                                                                                                                              Id of the owner.
                                                                                                                                            • repoId (integer )
                                                                                                                                              Id of repository.
                                                                                                                                              • Response

                                                                                                                                              • Http Status code
                                                                                                                                                200
                                                                                                                                              • Content-Type: application/json
                                                                                                                                              • Example
                                                                                                                                                Schema
                                                                                                                                              POST
                                                                                                                                              /repos/{ownerId}/{repoId}/issues/{number}/comments
                                                                                                                                              Description

                                                                                                                                              Create a comment.

                                                                                                                                              Request


                                                                                                                                              Uri Parameters
                                                                                                                                              • number (integer )
                                                                                                                                                Id of the issue.
                                                                                                                                              • ownerId (integer )
                                                                                                                                                Id of the owner.
                                                                                                                                              • repoId (integer )
                                                                                                                                                Id of repository.
                                                                                                                                              • Content-Type: application/json
                                                                                                                                              • Body
                                                                                                                                              • Schema
                                                                                                                                              • Response

                                                                                                                                              • Http Status code
                                                                                                                                                201
                                                                                                                                              • Content-Type: application/json
                                                                                                                                              • Example
                                                                                                                                                Schema
                                                                                                                                              URl: /repos/{ownerId}/{repoId}/issues/{number}/events

                                                                                                                                              GET
                                                                                                                                              /repos/{ownerId}/{repoId}/issues/{number}/events
                                                                                                                                              Description

                                                                                                                                              List issue events for a repository.

                                                                                                                                              Request


                                                                                                                                              Uri Parameters
                                                                                                                                              • number (integer )
                                                                                                                                                Id of the issue.
                                                                                                                                              • ownerId (integer )
                                                                                                                                                Id of the owner.
                                                                                                                                              • repoId (integer )
                                                                                                                                                Id of repository.
                                                                                                                                                • Response

                                                                                                                                                • Http Status code
                                                                                                                                                  200
                                                                                                                                                • Content-Type: application/json
                                                                                                                                                • Example
                                                                                                                                                  Schema
                                                                                                                                                URl: /repos/{ownerId}/{repoId}/issues/{number}/events/{eventId}

                                                                                                                                                GET
                                                                                                                                                /repos/{ownerId}/{repoId}/issues/{number}/events/{eventId}
                                                                                                                                                Description

                                                                                                                                                Get a single event.

                                                                                                                                                Request


                                                                                                                                                Uri Parameters
                                                                                                                                                • eventId (integer )
                                                                                                                                                  Id of the event.
                                                                                                                                                • number (integer )
                                                                                                                                                  Id of the issue.
                                                                                                                                                • ownerId (integer )
                                                                                                                                                  Id of the owner.
                                                                                                                                                • repoId (integer )
                                                                                                                                                  Id of repository.
                                                                                                                                                  • Response

                                                                                                                                                  • Http Status code
                                                                                                                                                    200
                                                                                                                                                  • Content-Type: application/json
                                                                                                                                                  • Example
                                                                                                                                                    Schema
                                                                                                                                                  URl: /repos/{ownerId}/{repoId}/issues/{number}/labels

                                                                                                                                                  GET
                                                                                                                                                  /repos/{ownerId}/{repoId}/issues/{number}/labels
                                                                                                                                                  Description

                                                                                                                                                  List labels on an issue.

                                                                                                                                                  Request


                                                                                                                                                  Uri Parameters
                                                                                                                                                  • number (integer )
                                                                                                                                                    Id of the issue.
                                                                                                                                                  • ownerId (integer )
                                                                                                                                                    Id of the owner.
                                                                                                                                                  • repoId (integer )
                                                                                                                                                    Id of repository.
                                                                                                                                                    • Response

                                                                                                                                                    • Http Status code
                                                                                                                                                      200
                                                                                                                                                    • Content-Type: application/json
                                                                                                                                                    • Example
                                                                                                                                                      Schema
                                                                                                                                                    POST
                                                                                                                                                    /repos/{ownerId}/{repoId}/issues/{number}/labels
                                                                                                                                                    Description

                                                                                                                                                    Add labels to an issue.

                                                                                                                                                    Request


                                                                                                                                                    Uri Parameters
                                                                                                                                                    • number (integer )
                                                                                                                                                      Id of the issue.
                                                                                                                                                    • ownerId (integer )
                                                                                                                                                      Id of the owner.
                                                                                                                                                    • repoId (integer )
                                                                                                                                                      Id of repository.
                                                                                                                                                    • Content-Type: application/json
                                                                                                                                                    • Body
                                                                                                                                                    • Schema
                                                                                                                                                    • Response

                                                                                                                                                    • Http Status code
                                                                                                                                                      201
                                                                                                                                                    • Content-Type: application/json
                                                                                                                                                    • Example
                                                                                                                                                      Schema
                                                                                                                                                    PUT
                                                                                                                                                    /repos/{ownerId}/{repoId}/issues/{number}/labels
                                                                                                                                                    Description

                                                                                                                                                    Replace all labels for an issue. Sending an empty array ([]) will remove all Labels from the Issue.

                                                                                                                                                    Request


                                                                                                                                                    Uri Parameters
                                                                                                                                                    • number (integer )
                                                                                                                                                      Id of the issue.
                                                                                                                                                    • ownerId (integer )
                                                                                                                                                      Id of the owner.
                                                                                                                                                    • repoId (integer )
                                                                                                                                                      Id of repository.
                                                                                                                                                    • Content-Type: application/json
                                                                                                                                                    • Body
                                                                                                                                                    • Schema
                                                                                                                                                    • Response

                                                                                                                                                    • Http Status code
                                                                                                                                                      201
                                                                                                                                                    • Content-Type: application/json
                                                                                                                                                    • Example
                                                                                                                                                      Schema
                                                                                                                                                    DELETE
                                                                                                                                                    /repos/{ownerId}/{repoId}/issues/{number}/labels
                                                                                                                                                    Description

                                                                                                                                                    Remove all labels from an issue.

                                                                                                                                                    Request


                                                                                                                                                    Uri Parameters
                                                                                                                                                    • number (integer )
                                                                                                                                                      Id of the issue.
                                                                                                                                                    • ownerId (integer )
                                                                                                                                                      Id of the owner.
                                                                                                                                                    • repoId (integer )
                                                                                                                                                      Id of repository.
                                                                                                                                                      • Response

                                                                                                                                                      URl: /repos/{ownerId}/{repoId}/issues/{number}/labels/{name}

                                                                                                                                                      DELETE
                                                                                                                                                      /repos/{ownerId}/{repoId}/issues/{number}/labels/{name}
                                                                                                                                                      Description

                                                                                                                                                      Remove a label from an issue.

                                                                                                                                                      Request


                                                                                                                                                      Uri Parameters
                                                                                                                                                      • name (string )
                                                                                                                                                        Name of the label.
                                                                                                                                                      • number (integer )
                                                                                                                                                        Id of the issue.
                                                                                                                                                      • ownerId (integer )
                                                                                                                                                        Id of the owner.
                                                                                                                                                      • repoId (integer )
                                                                                                                                                        Id of repository.

                                                                                                                                                      Headers
                                                                                                                                                      • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                                                                                                      • Accept: Is used to set specified media type.
                                                                                                                                                      • X-RateLimit-Limit:
                                                                                                                                                      • X-RateLimit-Remaining:
                                                                                                                                                      • X-RateLimit-Reset:
                                                                                                                                                      • X-GitHub-Request-Id:
                                                                                                                                                        • Response

                                                                                                                                                        • Http Status code
                                                                                                                                                          403
                                                                                                                                                          API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                                                                                                        • Http Status code
                                                                                                                                                          204
                                                                                                                                                          Item removed.
                                                                                                                                                        URl: /repos/{ownerId}/{repoId}/issues/comments

                                                                                                                                                        GET
                                                                                                                                                        /repos/{ownerId}/{repoId}/issues/comments
                                                                                                                                                        Description

                                                                                                                                                        List comments in a repository.

                                                                                                                                                        Request


                                                                                                                                                        Uri Parameters
                                                                                                                                                        • ownerId (integer )
                                                                                                                                                          Id of the owner.
                                                                                                                                                        • repoId (integer )
                                                                                                                                                          Id of repository.

                                                                                                                                                        Query parameters
                                                                                                                                                        • sort (string )
                                                                                                                                                        • direction (string )
                                                                                                                                                          Ignored without sort parameter.
                                                                                                                                                        • since (string )
                                                                                                                                                          Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
                                                                                                                                                          • Response

                                                                                                                                                          • Http Status code
                                                                                                                                                            200
                                                                                                                                                          • Content-Type: application/json
                                                                                                                                                          • Example
                                                                                                                                                            Schema
                                                                                                                                                          URl: /repos/{ownerId}/{repoId}/issues/comments/{commentId}

                                                                                                                                                          GET
                                                                                                                                                          /repos/{ownerId}/{repoId}/issues/comments/{commentId}
                                                                                                                                                          Description

                                                                                                                                                          Get a single comment.

                                                                                                                                                          Request


                                                                                                                                                          Uri Parameters
                                                                                                                                                          • commentId (integer )
                                                                                                                                                            Id of the comment.
                                                                                                                                                          • ownerId (integer )
                                                                                                                                                            Id of the owner.
                                                                                                                                                          • repoId (integer )
                                                                                                                                                            Id of repository.
                                                                                                                                                            • Response

                                                                                                                                                            • Http Status code
                                                                                                                                                              200
                                                                                                                                                            • Content-Type: application/json
                                                                                                                                                            • Example
                                                                                                                                                              Schema
                                                                                                                                                            PATCH
                                                                                                                                                            /repos/{ownerId}/{repoId}/issues/comments/{commentId}
                                                                                                                                                            Description

                                                                                                                                                            Edit a comment.

                                                                                                                                                            Request


                                                                                                                                                            Uri Parameters
                                                                                                                                                            • commentId (integer )
                                                                                                                                                              Id of the comment.
                                                                                                                                                            • ownerId (integer )
                                                                                                                                                              Id of the owner.
                                                                                                                                                            • repoId (integer )
                                                                                                                                                              Id of repository.
                                                                                                                                                            • Content-Type: application/json
                                                                                                                                                            • Body
                                                                                                                                                            • Schema
                                                                                                                                                            • Response

                                                                                                                                                            • Http Status code
                                                                                                                                                              200
                                                                                                                                                            • Content-Type: application/json
                                                                                                                                                            • Example
                                                                                                                                                              Schema
                                                                                                                                                            DELETE
                                                                                                                                                            /repos/{ownerId}/{repoId}/issues/comments/{commentId}
                                                                                                                                                            Description

                                                                                                                                                            Delete a comment.

                                                                                                                                                            Request


                                                                                                                                                            Uri Parameters
                                                                                                                                                            • commentId (integer )
                                                                                                                                                              Id of the comment.
                                                                                                                                                            • ownerId (integer )
                                                                                                                                                              Id of the owner.
                                                                                                                                                            • repoId (integer )
                                                                                                                                                              Id of repository.
                                                                                                                                                              • Response

                                                                                                                                                              • Http Status code
                                                                                                                                                                204
                                                                                                                                                                Item removed.
                                                                                                                                                              URl: /repos/{ownerId}/{repoId}/notifications

                                                                                                                                                              GET
                                                                                                                                                              /repos/{ownerId}/{repoId}/notifications
                                                                                                                                                              Description

                                                                                                                                                              List your notifications in a repository List all notifications for the current user.

                                                                                                                                                              Request


                                                                                                                                                              Uri Parameters
                                                                                                                                                              • ownerId (integer )
                                                                                                                                                                Id of the owner.
                                                                                                                                                              • repoId (integer )
                                                                                                                                                                Id of repository.

                                                                                                                                                              Query parameters
                                                                                                                                                              • all (string )
                                                                                                                                                                True to show notifications marked as read.
                                                                                                                                                              • participating (string )
                                                                                                                                                                True to show only notifications in which the user is directly participating or mentioned.
                                                                                                                                                              • since (string )
                                                                                                                                                                Time filters out any notifications updated before the given time. The time should be passed in as UTC in the ISO 8601 format YYYY-MM-DDTHH:MM:SSZ. Example: "2012-10-09T23:39:01Z".
                                                                                                                                                                • Response

                                                                                                                                                                • Http Status code
                                                                                                                                                                  200
                                                                                                                                                                • Content-Type: application/json
                                                                                                                                                                • Example
                                                                                                                                                                  Schema
                                                                                                                                                                PUT
                                                                                                                                                                /repos/{ownerId}/{repoId}/notifications
                                                                                                                                                                Description

                                                                                                                                                                Mark notifications as read in a repository. Marking all notifications in a repository as "read" removes them from the default view on GitHub.com.

                                                                                                                                                                Request


                                                                                                                                                                Uri Parameters
                                                                                                                                                                • ownerId (integer )
                                                                                                                                                                  Id of the owner.
                                                                                                                                                                • repoId (integer )
                                                                                                                                                                  Id of repository.
                                                                                                                                                                • Content-Type: application/json
                                                                                                                                                                • Body
                                                                                                                                                                • Schema
                                                                                                                                                                • Response

                                                                                                                                                                • Http Status code
                                                                                                                                                                  205
                                                                                                                                                                  Marked as read.
                                                                                                                                                                URl: /repos/{ownerId}/{repoId}/subscription

                                                                                                                                                                GET
                                                                                                                                                                /repos/{ownerId}/{repoId}/subscription
                                                                                                                                                                Description

                                                                                                                                                                Get a Repository Subscription.

                                                                                                                                                                Request


                                                                                                                                                                Uri Parameters
                                                                                                                                                                • ownerId (integer )
                                                                                                                                                                  Id of the owner.
                                                                                                                                                                • repoId (integer )
                                                                                                                                                                  Id of repository.
                                                                                                                                                                  • Response

                                                                                                                                                                  • Http Status code
                                                                                                                                                                    200
                                                                                                                                                                  • Content-Type: application/json
                                                                                                                                                                  • Example
                                                                                                                                                                    Schema
                                                                                                                                                                  PUT
                                                                                                                                                                  /repos/{ownerId}/{repoId}/subscription
                                                                                                                                                                  Description

                                                                                                                                                                  Set a Repository Subscription

                                                                                                                                                                  Request


                                                                                                                                                                  Uri Parameters
                                                                                                                                                                  • ownerId (integer )
                                                                                                                                                                    Id of the owner.
                                                                                                                                                                  • repoId (integer )
                                                                                                                                                                    Id of repository.
                                                                                                                                                                  • Content-Type: application/json
                                                                                                                                                                  • Body
                                                                                                                                                                  • Schema
                                                                                                                                                                  • Response

                                                                                                                                                                  • Http Status code
                                                                                                                                                                    200
                                                                                                                                                                  • Content-Type: application/json
                                                                                                                                                                  • Example
                                                                                                                                                                    Schema
                                                                                                                                                                  DELETE
                                                                                                                                                                  /repos/{ownerId}/{repoId}/subscription
                                                                                                                                                                  Description

                                                                                                                                                                  Delete a Repository Subscription.

                                                                                                                                                                  Request


                                                                                                                                                                  Uri Parameters
                                                                                                                                                                  • ownerId (integer )
                                                                                                                                                                    Id of the owner.
                                                                                                                                                                  • repoId (integer )
                                                                                                                                                                    Id of repository.
                                                                                                                                                                    • Response

                                                                                                                                                                    URl: /repos/{ownerId}/{repoId}/assignees

                                                                                                                                                                    GET
                                                                                                                                                                    /repos/{ownerId}/{repoId}/assignees
                                                                                                                                                                    Description

                                                                                                                                                                    List assignees. This call lists all the available assignees (owner collaborators) to which issues may be assigned.

                                                                                                                                                                    Request


                                                                                                                                                                    Uri Parameters
                                                                                                                                                                    • ownerId (integer )
                                                                                                                                                                      Id of the owner.
                                                                                                                                                                    • repoId (integer )
                                                                                                                                                                      Id of repository.
                                                                                                                                                                      • Response

                                                                                                                                                                      • Http Status code
                                                                                                                                                                        200
                                                                                                                                                                      • Content-Type: application/json
                                                                                                                                                                      • Example
                                                                                                                                                                        Schema
                                                                                                                                                                      URl: /repos/{ownerId}/{repoId}/assignees/{assignee}

                                                                                                                                                                      GET
                                                                                                                                                                      /repos/{ownerId}/{repoId}/assignees/{assignee}
                                                                                                                                                                      Description

                                                                                                                                                                      Check assignee. You may also check to see if a particular user is an assignee for a repository.

                                                                                                                                                                      Request


                                                                                                                                                                      Uri Parameters
                                                                                                                                                                      • assignee (string )
                                                                                                                                                                        Login of the assignee.
                                                                                                                                                                      • ownerId (integer )
                                                                                                                                                                        Id of the owner.
                                                                                                                                                                      • repoId (integer )
                                                                                                                                                                        Id of repository.

                                                                                                                                                                      Headers
                                                                                                                                                                      • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                                                                                                                      • Accept: Is used to set specified media type.
                                                                                                                                                                      • X-RateLimit-Limit:
                                                                                                                                                                      • X-RateLimit-Remaining:
                                                                                                                                                                      • X-RateLimit-Reset:
                                                                                                                                                                      • X-GitHub-Request-Id:
                                                                                                                                                                        • Response

                                                                                                                                                                        • Http Status code
                                                                                                                                                                          403
                                                                                                                                                                          API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                                                                                                                        • Http Status code
                                                                                                                                                                          204
                                                                                                                                                                          User is an assignee.
                                                                                                                                                                        • Http Status code
                                                                                                                                                                          404
                                                                                                                                                                          User isn't an assignee.
                                                                                                                                                                        URl: /repos/{ownerId}/{repoId}/labels

                                                                                                                                                                        GET
                                                                                                                                                                        /repos/{ownerId}/{repoId}/labels
                                                                                                                                                                        Description

                                                                                                                                                                        List all labels for this repository.

                                                                                                                                                                        Request


                                                                                                                                                                        Uri Parameters
                                                                                                                                                                        • ownerId (integer )
                                                                                                                                                                          Id of the owner.
                                                                                                                                                                        • repoId (integer )
                                                                                                                                                                          Id of repository.
                                                                                                                                                                          • Response

                                                                                                                                                                          • Http Status code
                                                                                                                                                                            200
                                                                                                                                                                          • Content-Type: application/json
                                                                                                                                                                          • Example
                                                                                                                                                                            Schema
                                                                                                                                                                          POST
                                                                                                                                                                          /repos/{ownerId}/{repoId}/labels
                                                                                                                                                                          Description

                                                                                                                                                                          Create a label.

                                                                                                                                                                          Request


                                                                                                                                                                          Uri Parameters
                                                                                                                                                                          • ownerId (integer )
                                                                                                                                                                            Id of the owner.
                                                                                                                                                                          • repoId (integer )
                                                                                                                                                                            Id of repository.
                                                                                                                                                                          • Content-Type: application/json
                                                                                                                                                                          • Body
                                                                                                                                                                          • Schema
                                                                                                                                                                          • Response

                                                                                                                                                                          • Http Status code
                                                                                                                                                                            201
                                                                                                                                                                          • Content-Type: application/json
                                                                                                                                                                          • Example
                                                                                                                                                                            Schema
                                                                                                                                                                          URl: /repos/{ownerId}/{repoId}/labels/{name}

                                                                                                                                                                          GET
                                                                                                                                                                          /repos/{ownerId}/{repoId}/labels/{name}
                                                                                                                                                                          Description

                                                                                                                                                                          Get a single label.

                                                                                                                                                                          Request


                                                                                                                                                                          Uri Parameters
                                                                                                                                                                          • name (string )
                                                                                                                                                                            Name of the label.
                                                                                                                                                                          • ownerId (integer )
                                                                                                                                                                            Id of the owner.
                                                                                                                                                                          • repoId (integer )
                                                                                                                                                                            Id of repository.
                                                                                                                                                                            • Response

                                                                                                                                                                            • Http Status code
                                                                                                                                                                              200
                                                                                                                                                                            • Content-Type: application/json
                                                                                                                                                                            • Example
                                                                                                                                                                              Schema
                                                                                                                                                                            PATCH
                                                                                                                                                                            /repos/{ownerId}/{repoId}/labels/{name}
                                                                                                                                                                            Description

                                                                                                                                                                            Update a label.

                                                                                                                                                                            Request


                                                                                                                                                                            Uri Parameters
                                                                                                                                                                            • name (string )
                                                                                                                                                                              Name of the label.
                                                                                                                                                                            • ownerId (integer )
                                                                                                                                                                              Id of the owner.
                                                                                                                                                                            • repoId (integer )
                                                                                                                                                                              Id of repository.
                                                                                                                                                                            • Content-Type: application/json
                                                                                                                                                                            • Body
                                                                                                                                                                            • Schema
                                                                                                                                                                            • Response

                                                                                                                                                                            • Http Status code
                                                                                                                                                                              200
                                                                                                                                                                            • Content-Type: application/json
                                                                                                                                                                            • Example
                                                                                                                                                                              Schema
                                                                                                                                                                            DELETE
                                                                                                                                                                            /repos/{ownerId}/{repoId}/labels/{name}
                                                                                                                                                                            Description

                                                                                                                                                                            Delete a label.

                                                                                                                                                                            Request


                                                                                                                                                                            Uri Parameters
                                                                                                                                                                            • name (string )
                                                                                                                                                                              Name of the label.
                                                                                                                                                                            • ownerId (integer )
                                                                                                                                                                              Id of the owner.
                                                                                                                                                                            • repoId (integer )
                                                                                                                                                                              Id of repository.
                                                                                                                                                                              • Response

                                                                                                                                                                              • Http Status code
                                                                                                                                                                                204
                                                                                                                                                                                Item removed.
                                                                                                                                                                              URl: /repos/{ownerId}/{repoId}/milestones

                                                                                                                                                                              GET
                                                                                                                                                                              /repos/{ownerId}/{repoId}/milestones
                                                                                                                                                                              Description

                                                                                                                                                                              List milestones for a repository.

                                                                                                                                                                              Request


                                                                                                                                                                              Uri Parameters
                                                                                                                                                                              • ownerId (integer )
                                                                                                                                                                                Id of the owner.
                                                                                                                                                                              • repoId (integer )
                                                                                                                                                                                Id of repository.

                                                                                                                                                                              Query parameters
                                                                                                                                                                              • state (string )
                                                                                                                                                                              • sort (string )
                                                                                                                                                                              • direction (string )
                                                                                                                                                                                • Response

                                                                                                                                                                                • Http Status code
                                                                                                                                                                                  200
                                                                                                                                                                                • Content-Type: application/json
                                                                                                                                                                                • Example
                                                                                                                                                                                  Schema
                                                                                                                                                                                POST
                                                                                                                                                                                /repos/{ownerId}/{repoId}/milestones
                                                                                                                                                                                Description

                                                                                                                                                                                Create a milestone.

                                                                                                                                                                                Request


                                                                                                                                                                                Uri Parameters
                                                                                                                                                                                • ownerId (integer )
                                                                                                                                                                                  Id of the owner.
                                                                                                                                                                                • repoId (integer )
                                                                                                                                                                                  Id of repository.
                                                                                                                                                                                • Content-Type: application/json
                                                                                                                                                                                • Body
                                                                                                                                                                                • Schema
                                                                                                                                                                                • Response

                                                                                                                                                                                • Http Status code
                                                                                                                                                                                  201
                                                                                                                                                                                • Content-Type: application/json
                                                                                                                                                                                • Example
                                                                                                                                                                                  Schema
                                                                                                                                                                                URl: /repos/{ownerId}/{repoId}/milestones/{number}

                                                                                                                                                                                GET
                                                                                                                                                                                /repos/{ownerId}/{repoId}/milestones/{number}
                                                                                                                                                                                Description

                                                                                                                                                                                Get a single milestone.

                                                                                                                                                                                Request


                                                                                                                                                                                Uri Parameters
                                                                                                                                                                                • number (integer )
                                                                                                                                                                                  Id of the milestone.
                                                                                                                                                                                • ownerId (integer )
                                                                                                                                                                                  Id of the owner.
                                                                                                                                                                                • repoId (integer )
                                                                                                                                                                                  Id of repository.
                                                                                                                                                                                  • Response

                                                                                                                                                                                  • Http Status code
                                                                                                                                                                                    200
                                                                                                                                                                                  • Content-Type: application/json
                                                                                                                                                                                  • Example
                                                                                                                                                                                    Schema
                                                                                                                                                                                  PATCH
                                                                                                                                                                                  /repos/{ownerId}/{repoId}/milestones/{number}
                                                                                                                                                                                  Description

                                                                                                                                                                                  Update a milestone.

                                                                                                                                                                                  Request


                                                                                                                                                                                  Uri Parameters
                                                                                                                                                                                  • number (integer )
                                                                                                                                                                                    Id of the milestone.
                                                                                                                                                                                  • ownerId (integer )
                                                                                                                                                                                    Id of the owner.
                                                                                                                                                                                  • repoId (integer )
                                                                                                                                                                                    Id of repository.
                                                                                                                                                                                  • Content-Type: application/json
                                                                                                                                                                                  • Body
                                                                                                                                                                                  • Schema
                                                                                                                                                                                  • Response

                                                                                                                                                                                  • Http Status code
                                                                                                                                                                                    200
                                                                                                                                                                                  • Content-Type: application/json
                                                                                                                                                                                  • Example
                                                                                                                                                                                    Schema
                                                                                                                                                                                  DELETE
                                                                                                                                                                                  /repos/{ownerId}/{repoId}/milestones/{number}
                                                                                                                                                                                  Description

                                                                                                                                                                                  Delete a milestone.

                                                                                                                                                                                  Request


                                                                                                                                                                                  Uri Parameters
                                                                                                                                                                                  • number (integer )
                                                                                                                                                                                    Id of the milestone.
                                                                                                                                                                                  • ownerId (integer )
                                                                                                                                                                                    Id of the owner.
                                                                                                                                                                                  • repoId (integer )
                                                                                                                                                                                    Id of repository.
                                                                                                                                                                                    • Response

                                                                                                                                                                                    • Http Status code
                                                                                                                                                                                      204
                                                                                                                                                                                      Item removed.
                                                                                                                                                                                    URl: /repos/{ownerId}/{repoId}/milestones/{number}/labels

                                                                                                                                                                                    GET
                                                                                                                                                                                    /repos/{ownerId}/{repoId}/milestones/{number}/labels
                                                                                                                                                                                    Description

                                                                                                                                                                                    Get labels for every issue in a milestone.

                                                                                                                                                                                    Request


                                                                                                                                                                                    Uri Parameters
                                                                                                                                                                                    • number (integer )
                                                                                                                                                                                      Id of the milestone.
                                                                                                                                                                                    • ownerId (integer )
                                                                                                                                                                                      Id of the owner.
                                                                                                                                                                                    • repoId (integer )
                                                                                                                                                                                      Id of repository.
                                                                                                                                                                                      • Response

                                                                                                                                                                                      • Http Status code
                                                                                                                                                                                        200
                                                                                                                                                                                      • Content-Type: application/json
                                                                                                                                                                                      • Example
                                                                                                                                                                                        Schema
                                                                                                                                                                                      URl: /repos/{ownerId}/{repoId}/pulls

                                                                                                                                                                                      GET
                                                                                                                                                                                      /repos/{ownerId}/{repoId}/pulls
                                                                                                                                                                                      Description

                                                                                                                                                                                      List pull requests.

                                                                                                                                                                                      Request


                                                                                                                                                                                      Uri Parameters
                                                                                                                                                                                      • ownerId (integer )
                                                                                                                                                                                        Id of the owner.
                                                                                                                                                                                      • repoId (integer )
                                                                                                                                                                                        Id of repository.

                                                                                                                                                                                      Query parameters
                                                                                                                                                                                      • state (string )
                                                                                                                                                                                        String to filter by state.
                                                                                                                                                                                      • head (string )
                                                                                                                                                                                        Filter pulls by head user and branch name in the format of 'user:ref-name'. Example: github:new-script-format.
                                                                                                                                                                                      • base (string )
                                                                                                                                                                                        Filter pulls by base branch name. Example - gh-pages.
                                                                                                                                                                                        • Response

                                                                                                                                                                                        • Http Status code
                                                                                                                                                                                          200
                                                                                                                                                                                        • Content-Type: application/json
                                                                                                                                                                                        • Example
                                                                                                                                                                                          Schema
                                                                                                                                                                                        POST
                                                                                                                                                                                        /repos/{ownerId}/{repoId}/pulls
                                                                                                                                                                                        Description

                                                                                                                                                                                        Create a pull request.

                                                                                                                                                                                        Request


                                                                                                                                                                                        Uri Parameters
                                                                                                                                                                                        • ownerId (integer )
                                                                                                                                                                                          Id of the owner.
                                                                                                                                                                                        • repoId (integer )
                                                                                                                                                                                          Id of repository.
                                                                                                                                                                                          • Response

                                                                                                                                                                                          • Http Status code
                                                                                                                                                                                            201
                                                                                                                                                                                          • Content-Type: application/json
                                                                                                                                                                                          • Example
                                                                                                                                                                                            Schema
                                                                                                                                                                                          URl: /repos/{ownerId}/{repoId}/pulls/{number}

                                                                                                                                                                                          GET
                                                                                                                                                                                          /repos/{ownerId}/{repoId}/pulls/{number}
                                                                                                                                                                                          Description

                                                                                                                                                                                          Get a single pull request.

                                                                                                                                                                                          Request


                                                                                                                                                                                          Uri Parameters
                                                                                                                                                                                          • number (integer )
                                                                                                                                                                                            Id of a pull.
                                                                                                                                                                                          • ownerId (integer )
                                                                                                                                                                                            Id of the owner.
                                                                                                                                                                                          • repoId (integer )
                                                                                                                                                                                            Id of repository.
                                                                                                                                                                                            • Response

                                                                                                                                                                                            • Http Status code
                                                                                                                                                                                              200
                                                                                                                                                                                            • Content-Type: application/json
                                                                                                                                                                                            • Example
                                                                                                                                                                                              Schema
                                                                                                                                                                                            PATCH
                                                                                                                                                                                            /repos/{ownerId}/{repoId}/pulls/{number}
                                                                                                                                                                                            Description

                                                                                                                                                                                            Update a pull request.

                                                                                                                                                                                            Request


                                                                                                                                                                                            Uri Parameters
                                                                                                                                                                                            • number (integer )
                                                                                                                                                                                              Id of a pull.
                                                                                                                                                                                            • ownerId (integer )
                                                                                                                                                                                              Id of the owner.
                                                                                                                                                                                            • repoId (integer )
                                                                                                                                                                                              Id of repository.
                                                                                                                                                                                            • Content-Type: application/json
                                                                                                                                                                                            • Body
                                                                                                                                                                                            • Schema
                                                                                                                                                                                            • Response

                                                                                                                                                                                            • Http Status code
                                                                                                                                                                                              200
                                                                                                                                                                                            • Content-Type: application/json
                                                                                                                                                                                            • Example
                                                                                                                                                                                              Schema
                                                                                                                                                                                            URl: /repos/{ownerId}/{repoId}/pulls/{number}/files

                                                                                                                                                                                            GET
                                                                                                                                                                                            /repos/{ownerId}/{repoId}/pulls/{number}/files
                                                                                                                                                                                            Description

                                                                                                                                                                                            List pull requests files.

                                                                                                                                                                                            Request


                                                                                                                                                                                            Uri Parameters
                                                                                                                                                                                            • number (integer )
                                                                                                                                                                                              Id of a pull.
                                                                                                                                                                                            • ownerId (integer )
                                                                                                                                                                                              Id of the owner.
                                                                                                                                                                                            • repoId (integer )
                                                                                                                                                                                              Id of repository.
                                                                                                                                                                                              • Response

                                                                                                                                                                                              • Http Status code
                                                                                                                                                                                                200
                                                                                                                                                                                              • Content-Type: application/json
                                                                                                                                                                                              • Example
                                                                                                                                                                                                Schema
                                                                                                                                                                                              URl: /repos/{ownerId}/{repoId}/pulls/{number}/commits

                                                                                                                                                                                              GET
                                                                                                                                                                                              /repos/{ownerId}/{repoId}/pulls/{number}/commits
                                                                                                                                                                                              Description

                                                                                                                                                                                              List commits on a pull request.

                                                                                                                                                                                              Request


                                                                                                                                                                                              Uri Parameters
                                                                                                                                                                                              • number (integer )
                                                                                                                                                                                                Id of a pull.
                                                                                                                                                                                              • ownerId (integer )
                                                                                                                                                                                                Id of the owner.
                                                                                                                                                                                              • repoId (integer )
                                                                                                                                                                                                Id of repository.
                                                                                                                                                                                                • Response

                                                                                                                                                                                                • Http Status code
                                                                                                                                                                                                  200
                                                                                                                                                                                                • Content-Type: application/json
                                                                                                                                                                                                • Example
                                                                                                                                                                                                  Schema
                                                                                                                                                                                                URl: /repos/{ownerId}/{repoId}/pulls/{number}/merge

                                                                                                                                                                                                GET
                                                                                                                                                                                                /repos/{ownerId}/{repoId}/pulls/{number}/merge
                                                                                                                                                                                                Description

                                                                                                                                                                                                Get if a pull request has been merged.

                                                                                                                                                                                                Request


                                                                                                                                                                                                Uri Parameters
                                                                                                                                                                                                • number (integer )
                                                                                                                                                                                                  Id of a pull.
                                                                                                                                                                                                • ownerId (integer )
                                                                                                                                                                                                  Id of the owner.
                                                                                                                                                                                                • repoId (integer )
                                                                                                                                                                                                  Id of repository.

                                                                                                                                                                                                Headers
                                                                                                                                                                                                • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                                                                                                                                                • Accept: Is used to set specified media type.
                                                                                                                                                                                                • X-RateLimit-Limit:
                                                                                                                                                                                                • X-RateLimit-Remaining:
                                                                                                                                                                                                • X-RateLimit-Reset:
                                                                                                                                                                                                • X-GitHub-Request-Id:
                                                                                                                                                                                                  • Response

                                                                                                                                                                                                  • Http Status code
                                                                                                                                                                                                    403
                                                                                                                                                                                                    API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                                                                                                                                                  • Http Status code
                                                                                                                                                                                                    204
                                                                                                                                                                                                    Pull request has been merged.
                                                                                                                                                                                                  • Http Status code
                                                                                                                                                                                                    404
                                                                                                                                                                                                    Pull request has not been merged.
                                                                                                                                                                                                  PUT
                                                                                                                                                                                                  /repos/{ownerId}/{repoId}/pulls/{number}/merge
                                                                                                                                                                                                  Description

                                                                                                                                                                                                  Merge a pull request (Merge Button™)

                                                                                                                                                                                                  Request


                                                                                                                                                                                                  Uri Parameters
                                                                                                                                                                                                  • number (integer )
                                                                                                                                                                                                    Id of a pull.
                                                                                                                                                                                                  • ownerId (integer )
                                                                                                                                                                                                    Id of the owner.
                                                                                                                                                                                                  • repoId (integer )
                                                                                                                                                                                                    Id of repository.

                                                                                                                                                                                                  Headers
                                                                                                                                                                                                  • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                                                                                                                                                  • Accept: Is used to set specified media type.
                                                                                                                                                                                                  • X-RateLimit-Limit:
                                                                                                                                                                                                  • X-RateLimit-Remaining:
                                                                                                                                                                                                  • X-RateLimit-Reset:
                                                                                                                                                                                                  • X-GitHub-Request-Id:
                                                                                                                                                                                                  • Content-Type: application/json
                                                                                                                                                                                                  • Body
                                                                                                                                                                                                  • Schema
                                                                                                                                                                                                  • Response

                                                                                                                                                                                                  • Http Status code
                                                                                                                                                                                                    403
                                                                                                                                                                                                    API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                                                                                                                                                  • Http Status code
                                                                                                                                                                                                    200
                                                                                                                                                                                                    Response if merge was successful.
                                                                                                                                                                                                  • Content-Type: application/json
                                                                                                                                                                                                  • Example
                                                                                                                                                                                                    Schema
                                                                                                                                                                                                  • Http Status code
                                                                                                                                                                                                    405
                                                                                                                                                                                                    Response if merge cannot be performed.
                                                                                                                                                                                                  • Content-Type: application/json
                                                                                                                                                                                                  • Example
                                                                                                                                                                                                    Schema
                                                                                                                                                                                                  URl: /repos/{ownerId}/{repoId}/pulls/{number}/comments

                                                                                                                                                                                                  GET
                                                                                                                                                                                                  /repos/{ownerId}/{repoId}/pulls/{number}/comments
                                                                                                                                                                                                  Description

                                                                                                                                                                                                  List comments on a pull request.

                                                                                                                                                                                                  Request


                                                                                                                                                                                                  Uri Parameters
                                                                                                                                                                                                  • number (integer )
                                                                                                                                                                                                    Id of a pull.
                                                                                                                                                                                                  • ownerId (integer )
                                                                                                                                                                                                    Id of the owner.
                                                                                                                                                                                                  • repoId (integer )
                                                                                                                                                                                                    Id of repository.
                                                                                                                                                                                                    • Response

                                                                                                                                                                                                    • Http Status code
                                                                                                                                                                                                      200
                                                                                                                                                                                                    • Content-Type: application/json
                                                                                                                                                                                                    • Example
                                                                                                                                                                                                      Schema
                                                                                                                                                                                                    POST
                                                                                                                                                                                                    /repos/{ownerId}/{repoId}/pulls/{number}/comments
                                                                                                                                                                                                    Description

                                                                                                                                                                                                    Create a comment. description: | Alternative Input. Instead of passing commit_id, path, and position you can reply to an existing Pull Request Comment like this: body Required string in_reply_to Required number - Comment id to reply to.

                                                                                                                                                                                                    Request


                                                                                                                                                                                                    Uri Parameters
                                                                                                                                                                                                    • number (integer )
                                                                                                                                                                                                      Id of a pull.
                                                                                                                                                                                                    • ownerId (integer )
                                                                                                                                                                                                      Id of the owner.
                                                                                                                                                                                                    • repoId (integer )
                                                                                                                                                                                                      Id of repository.
                                                                                                                                                                                                    • Content-Type: application/json
                                                                                                                                                                                                    • Body
                                                                                                                                                                                                    • Schema
                                                                                                                                                                                                    • Response

                                                                                                                                                                                                    • Http Status code
                                                                                                                                                                                                      201
                                                                                                                                                                                                    • Content-Type: application/json
                                                                                                                                                                                                    • Example
                                                                                                                                                                                                      Schema
                                                                                                                                                                                                    URl: /repos/{ownerId}/{repoId}/pulls/comments

                                                                                                                                                                                                    GET
                                                                                                                                                                                                    /repos/{ownerId}/{repoId}/pulls/comments
                                                                                                                                                                                                    Description

                                                                                                                                                                                                    List comments in a repository. By default, Review Comments are ordered by ascending ID.

                                                                                                                                                                                                    Request


                                                                                                                                                                                                    Uri Parameters
                                                                                                                                                                                                    • ownerId (integer )
                                                                                                                                                                                                      Id of the owner.
                                                                                                                                                                                                    • repoId (integer )
                                                                                                                                                                                                      Id of repository.

                                                                                                                                                                                                    Query parameters
                                                                                                                                                                                                    • sort (string )
                                                                                                                                                                                                    • direction (string )
                                                                                                                                                                                                      Ignored without 'sort' parameter.
                                                                                                                                                                                                    • since (string )
                                                                                                                                                                                                      Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ
                                                                                                                                                                                                      • Response

                                                                                                                                                                                                      • Http Status code
                                                                                                                                                                                                        200
                                                                                                                                                                                                      • Content-Type: application/json
                                                                                                                                                                                                      • Example
                                                                                                                                                                                                        Schema
                                                                                                                                                                                                      URl: /repos/{ownerId}/{repoId}/pulls/comments/{number}

                                                                                                                                                                                                      GET
                                                                                                                                                                                                      /repos/{ownerId}/{repoId}/pulls/comments/{number}
                                                                                                                                                                                                      Description

                                                                                                                                                                                                      Get a single comment.

                                                                                                                                                                                                      Request


                                                                                                                                                                                                      Uri Parameters
                                                                                                                                                                                                      • number (integer )
                                                                                                                                                                                                        Id of the comment.
                                                                                                                                                                                                      • ownerId (integer )
                                                                                                                                                                                                        Id of the owner.
                                                                                                                                                                                                      • repoId (integer )
                                                                                                                                                                                                        Id of repository.
                                                                                                                                                                                                        • Response

                                                                                                                                                                                                        • Http Status code
                                                                                                                                                                                                          200
                                                                                                                                                                                                        • Content-Type: application/json
                                                                                                                                                                                                        • Example
                                                                                                                                                                                                          Schema
                                                                                                                                                                                                        PATCH
                                                                                                                                                                                                        /repos/{ownerId}/{repoId}/pulls/comments/{number}
                                                                                                                                                                                                        Description

                                                                                                                                                                                                        Edit a comment.

                                                                                                                                                                                                        Request


                                                                                                                                                                                                        Uri Parameters
                                                                                                                                                                                                        • number (integer )
                                                                                                                                                                                                          Id of the comment.
                                                                                                                                                                                                        • ownerId (integer )
                                                                                                                                                                                                          Id of the owner.
                                                                                                                                                                                                        • repoId (integer )
                                                                                                                                                                                                          Id of repository.
                                                                                                                                                                                                        • Content-Type: application/json
                                                                                                                                                                                                        • Body
                                                                                                                                                                                                        • Schema
                                                                                                                                                                                                        • Response

                                                                                                                                                                                                        • Http Status code
                                                                                                                                                                                                          200
                                                                                                                                                                                                        • Content-Type: application/json
                                                                                                                                                                                                        • Example
                                                                                                                                                                                                          Schema
                                                                                                                                                                                                        DELETE
                                                                                                                                                                                                        /repos/{ownerId}/{repoId}/pulls/comments/{number}
                                                                                                                                                                                                        Description

                                                                                                                                                                                                        Delete a comment.

                                                                                                                                                                                                        Request


                                                                                                                                                                                                        Uri Parameters
                                                                                                                                                                                                        • number (integer )
                                                                                                                                                                                                          Id of the comment.
                                                                                                                                                                                                        • ownerId (integer )
                                                                                                                                                                                                          Id of the owner.
                                                                                                                                                                                                        • repoId (integer )
                                                                                                                                                                                                          Id of repository.
                                                                                                                                                                                                          • Response

                                                                                                                                                                                                          • Http Status code
                                                                                                                                                                                                            204
                                                                                                                                                                                                            Item removed.
                                                                                                                                                                                                          URl: /repos/{ownerId}/{repoId}/collaborators

                                                                                                                                                                                                          GET
                                                                                                                                                                                                          /repos/{ownerId}/{repoId}/collaborators
                                                                                                                                                                                                          Description

                                                                                                                                                                                                          List. When authenticating as an organization owner of an organization-owned repository, all organization owners are included in the list of collaborators. Otherwise, only users with access to the repository are returned in the collaborators list.

                                                                                                                                                                                                          Request


                                                                                                                                                                                                          Uri Parameters
                                                                                                                                                                                                          • ownerId (integer )
                                                                                                                                                                                                            Id of the owner.
                                                                                                                                                                                                          • repoId (integer )
                                                                                                                                                                                                            Id of repository.
                                                                                                                                                                                                            • Response

                                                                                                                                                                                                            • Http Status code
                                                                                                                                                                                                              200
                                                                                                                                                                                                            • Content-Type: application/json
                                                                                                                                                                                                            • Example
                                                                                                                                                                                                              Schema
                                                                                                                                                                                                            URl: /repos/{ownerId}/{repoId}/collaborators/{user}

                                                                                                                                                                                                            GET
                                                                                                                                                                                                            /repos/{ownerId}/{repoId}/collaborators/{user}
                                                                                                                                                                                                            Description

                                                                                                                                                                                                            Check if user is a collaborator

                                                                                                                                                                                                            Request


                                                                                                                                                                                                            Uri Parameters
                                                                                                                                                                                                            • user (string )
                                                                                                                                                                                                              Login of the user.
                                                                                                                                                                                                            • ownerId (integer )
                                                                                                                                                                                                              Id of the owner.
                                                                                                                                                                                                            • repoId (integer )
                                                                                                                                                                                                              Id of repository.

                                                                                                                                                                                                            Headers
                                                                                                                                                                                                            • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                                                                                                                                                            • Accept: Is used to set specified media type.
                                                                                                                                                                                                            • X-RateLimit-Limit:
                                                                                                                                                                                                            • X-RateLimit-Remaining:
                                                                                                                                                                                                            • X-RateLimit-Reset:
                                                                                                                                                                                                            • X-GitHub-Request-Id:
                                                                                                                                                                                                              • Response

                                                                                                                                                                                                              • Http Status code
                                                                                                                                                                                                                403
                                                                                                                                                                                                                API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                                                                                                                                                              • Http Status code
                                                                                                                                                                                                                204
                                                                                                                                                                                                                User is a collaborator.
                                                                                                                                                                                                              • Http Status code
                                                                                                                                                                                                                404
                                                                                                                                                                                                                User is not a collaborator.
                                                                                                                                                                                                              PUT
                                                                                                                                                                                                              /repos/{ownerId}/{repoId}/collaborators/{user}
                                                                                                                                                                                                              Description

                                                                                                                                                                                                              Add collaborator.

                                                                                                                                                                                                              Request


                                                                                                                                                                                                              Uri Parameters
                                                                                                                                                                                                              • user (string )
                                                                                                                                                                                                                Login of the user.
                                                                                                                                                                                                              • ownerId (integer )
                                                                                                                                                                                                                Id of the owner.
                                                                                                                                                                                                              • repoId (integer )
                                                                                                                                                                                                                Id of repository.

                                                                                                                                                                                                              Headers
                                                                                                                                                                                                              • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                                                                                                                                                              • Accept: Is used to set specified media type.
                                                                                                                                                                                                              • X-RateLimit-Limit:
                                                                                                                                                                                                              • X-RateLimit-Remaining:
                                                                                                                                                                                                              • X-RateLimit-Reset:
                                                                                                                                                                                                              • X-GitHub-Request-Id:
                                                                                                                                                                                                                • Response

                                                                                                                                                                                                                • Http Status code
                                                                                                                                                                                                                  403
                                                                                                                                                                                                                  API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                                                                                                                                                                • Http Status code
                                                                                                                                                                                                                  204
                                                                                                                                                                                                                  Collaborator added.
                                                                                                                                                                                                                DELETE
                                                                                                                                                                                                                /repos/{ownerId}/{repoId}/collaborators/{user}
                                                                                                                                                                                                                Description

                                                                                                                                                                                                                Remove collaborator.

                                                                                                                                                                                                                Request


                                                                                                                                                                                                                Uri Parameters
                                                                                                                                                                                                                • user (string )
                                                                                                                                                                                                                  Login of the user.
                                                                                                                                                                                                                • ownerId (integer )
                                                                                                                                                                                                                  Id of the owner.
                                                                                                                                                                                                                • repoId (integer )
                                                                                                                                                                                                                  Id of repository.

                                                                                                                                                                                                                Headers
                                                                                                                                                                                                                • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                                                                                                                                                                • Accept: Is used to set specified media type.
                                                                                                                                                                                                                • X-RateLimit-Limit:
                                                                                                                                                                                                                • X-RateLimit-Remaining:
                                                                                                                                                                                                                • X-RateLimit-Reset:
                                                                                                                                                                                                                • X-GitHub-Request-Id:
                                                                                                                                                                                                                  • Response

                                                                                                                                                                                                                  • Http Status code
                                                                                                                                                                                                                    403
                                                                                                                                                                                                                    API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                                                                                                                                                                  • Http Status code
                                                                                                                                                                                                                    204
                                                                                                                                                                                                                    Collaborator removed.
                                                                                                                                                                                                                  URl: /repos/{ownerId}/{repoId}/comments

                                                                                                                                                                                                                  GET
                                                                                                                                                                                                                  /repos/{ownerId}/{repoId}/comments
                                                                                                                                                                                                                  Description

                                                                                                                                                                                                                  List commit comments for a repository. Comments are ordered by ascending ID.

                                                                                                                                                                                                                  Request


                                                                                                                                                                                                                  Uri Parameters
                                                                                                                                                                                                                  • ownerId (integer )
                                                                                                                                                                                                                    Id of the owner.
                                                                                                                                                                                                                  • repoId (integer )
                                                                                                                                                                                                                    Id of repository.
                                                                                                                                                                                                                    • Response

                                                                                                                                                                                                                    • Http Status code
                                                                                                                                                                                                                      200
                                                                                                                                                                                                                    • Content-Type: application/json
                                                                                                                                                                                                                    • Example
                                                                                                                                                                                                                      Schema
                                                                                                                                                                                                                    URl: /repos/{ownerId}/{repoId}/comments/{commentId}

                                                                                                                                                                                                                    GET
                                                                                                                                                                                                                    /repos/{ownerId}/{repoId}/comments/{commentId}
                                                                                                                                                                                                                    Description

                                                                                                                                                                                                                    Get a single commit comment.

                                                                                                                                                                                                                    Request


                                                                                                                                                                                                                    Uri Parameters
                                                                                                                                                                                                                    • commentId (integer )
                                                                                                                                                                                                                      Id of a comment.
                                                                                                                                                                                                                    • ownerId (integer )
                                                                                                                                                                                                                      Id of the owner.
                                                                                                                                                                                                                    • repoId (integer )
                                                                                                                                                                                                                      Id of repository.
                                                                                                                                                                                                                      • Response

                                                                                                                                                                                                                      • Http Status code
                                                                                                                                                                                                                        200
                                                                                                                                                                                                                      • Content-Type: application/json
                                                                                                                                                                                                                      • Example
                                                                                                                                                                                                                        Schema
                                                                                                                                                                                                                      PATCH
                                                                                                                                                                                                                      /repos/{ownerId}/{repoId}/comments/{commentId}
                                                                                                                                                                                                                      Description

                                                                                                                                                                                                                      Update a commit comment.

                                                                                                                                                                                                                      Request


                                                                                                                                                                                                                      Uri Parameters
                                                                                                                                                                                                                      • commentId (integer )
                                                                                                                                                                                                                        Id of a comment.
                                                                                                                                                                                                                      • ownerId (integer )
                                                                                                                                                                                                                        Id of the owner.
                                                                                                                                                                                                                      • repoId (integer )
                                                                                                                                                                                                                        Id of repository.
                                                                                                                                                                                                                      • Content-Type: application/json
                                                                                                                                                                                                                      • Body
                                                                                                                                                                                                                      • Schema
                                                                                                                                                                                                                      • Response

                                                                                                                                                                                                                      • Http Status code
                                                                                                                                                                                                                        200
                                                                                                                                                                                                                      • Content-Type: application/json
                                                                                                                                                                                                                      • Example
                                                                                                                                                                                                                        Schema
                                                                                                                                                                                                                      DELETE
                                                                                                                                                                                                                      /repos/{ownerId}/{repoId}/comments/{commentId}
                                                                                                                                                                                                                      Description

                                                                                                                                                                                                                      Delete a commit comment

                                                                                                                                                                                                                      Request


                                                                                                                                                                                                                      Uri Parameters
                                                                                                                                                                                                                      • commentId (integer )
                                                                                                                                                                                                                        Id of a comment.
                                                                                                                                                                                                                      • ownerId (integer )
                                                                                                                                                                                                                        Id of the owner.
                                                                                                                                                                                                                      • repoId (integer )
                                                                                                                                                                                                                        Id of repository.
                                                                                                                                                                                                                        • Response

                                                                                                                                                                                                                        • Http Status code
                                                                                                                                                                                                                          204
                                                                                                                                                                                                                          Item removed.
                                                                                                                                                                                                                        URl: /repos/{ownerId}/{repoId}/commits

                                                                                                                                                                                                                        GET
                                                                                                                                                                                                                        /repos/{ownerId}/{repoId}/commits
                                                                                                                                                                                                                        Description

                                                                                                                                                                                                                        List commits on a repository.

                                                                                                                                                                                                                        Request


                                                                                                                                                                                                                        Uri Parameters
                                                                                                                                                                                                                        • ownerId (integer )
                                                                                                                                                                                                                          Id of the owner.
                                                                                                                                                                                                                        • repoId (integer )
                                                                                                                                                                                                                          Id of repository.

                                                                                                                                                                                                                        Query parameters
                                                                                                                                                                                                                        • sha (string )
                                                                                                                                                                                                                          Sha or branch to start listing commits from.
                                                                                                                                                                                                                        • path (string )
                                                                                                                                                                                                                          Only commits containing this file path will be returned.
                                                                                                                                                                                                                        • author (string )
                                                                                                                                                                                                                          GitHub login, name, or email by which to filter by commit author.
                                                                                                                                                                                                                        • since (string )
                                                                                                                                                                                                                          ISO 8601 Date - Only commits after this date will be returned.
                                                                                                                                                                                                                        • until (string )
                                                                                                                                                                                                                          ISO 8601 Date - Only commits before this date will be returned.
                                                                                                                                                                                                                          • Response

                                                                                                                                                                                                                          • Http Status code
                                                                                                                                                                                                                            200
                                                                                                                                                                                                                          • Content-Type: application/json
                                                                                                                                                                                                                          • Example
                                                                                                                                                                                                                            Schema
                                                                                                                                                                                                                          URl: /repos/{ownerId}/{repoId}/commits/{shaCode}

                                                                                                                                                                                                                          GET
                                                                                                                                                                                                                          /repos/{ownerId}/{repoId}/commits/{shaCode}
                                                                                                                                                                                                                          Description

                                                                                                                                                                                                                          Get a single commit.

                                                                                                                                                                                                                          Request


                                                                                                                                                                                                                          Uri Parameters
                                                                                                                                                                                                                          • shaCode (string )
                                                                                                                                                                                                                            SHA-1 code of the commit.
                                                                                                                                                                                                                          • ownerId (integer )
                                                                                                                                                                                                                            Id of the owner.
                                                                                                                                                                                                                          • repoId (integer )
                                                                                                                                                                                                                            Id of repository.
                                                                                                                                                                                                                            • Response

                                                                                                                                                                                                                            • Http Status code
                                                                                                                                                                                                                              200
                                                                                                                                                                                                                            • Content-Type: application/json
                                                                                                                                                                                                                            • Example
                                                                                                                                                                                                                              Schema
                                                                                                                                                                                                                            URl: /repos/{ownerId}/{repoId}/commits/{shaCode}/comments

                                                                                                                                                                                                                            GET
                                                                                                                                                                                                                            /repos/{ownerId}/{repoId}/commits/{shaCode}/comments
                                                                                                                                                                                                                            Description

                                                                                                                                                                                                                            List comments for a single commitList comments for a single commit.

                                                                                                                                                                                                                            Request


                                                                                                                                                                                                                            Uri Parameters
                                                                                                                                                                                                                            • shaCode (string )
                                                                                                                                                                                                                              SHA-1 code of the commit.
                                                                                                                                                                                                                            • ownerId (integer )
                                                                                                                                                                                                                              Id of the owner.
                                                                                                                                                                                                                            • repoId (integer )
                                                                                                                                                                                                                              Id of repository.
                                                                                                                                                                                                                              • Response

                                                                                                                                                                                                                              • Http Status code
                                                                                                                                                                                                                                200
                                                                                                                                                                                                                              • Content-Type: application/json
                                                                                                                                                                                                                              • Example
                                                                                                                                                                                                                                Schema
                                                                                                                                                                                                                              POST
                                                                                                                                                                                                                              /repos/{ownerId}/{repoId}/commits/{shaCode}/comments
                                                                                                                                                                                                                              Description

                                                                                                                                                                                                                              Create a commit comment.

                                                                                                                                                                                                                              Request


                                                                                                                                                                                                                              Uri Parameters
                                                                                                                                                                                                                              • shaCode (string )
                                                                                                                                                                                                                                SHA-1 code of the commit.
                                                                                                                                                                                                                              • ownerId (integer )
                                                                                                                                                                                                                                Id of the owner.
                                                                                                                                                                                                                              • repoId (integer )
                                                                                                                                                                                                                                Id of repository.
                                                                                                                                                                                                                              • Content-Type: application/json
                                                                                                                                                                                                                              • Body
                                                                                                                                                                                                                              • Schema
                                                                                                                                                                                                                              • Response

                                                                                                                                                                                                                              • Http Status code
                                                                                                                                                                                                                                201
                                                                                                                                                                                                                              • Content-Type: application/json
                                                                                                                                                                                                                              • Example
                                                                                                                                                                                                                                Schema
                                                                                                                                                                                                                              URl: /repos/{ownerId}/{repoId}/contents/{path}

                                                                                                                                                                                                                              GET
                                                                                                                                                                                                                              /repos/{ownerId}/{repoId}/contents/{path}
                                                                                                                                                                                                                              Description

                                                                                                                                                                                                                              Get contents. This method returns the contents of a file or directory in a repository. Files and symlinks support a custom media type for getting the raw content. Directories and submodules do not support custom media types. Note: This API supports files up to 1 megabyte in size. Here can be many outcomes. For details see "http://developer.github.com/v3/repos/contents/"

                                                                                                                                                                                                                              Request


                                                                                                                                                                                                                              Uri Parameters
                                                                                                                                                                                                                              • path (string )
                                                                                                                                                                                                                              • ownerId (integer )
                                                                                                                                                                                                                                Id of the owner.
                                                                                                                                                                                                                              • repoId (integer )
                                                                                                                                                                                                                                Id of repository.

                                                                                                                                                                                                                              Query parameters
                                                                                                                                                                                                                              • path (string )
                                                                                                                                                                                                                                The content path.
                                                                                                                                                                                                                              • ref (string )
                                                                                                                                                                                                                                The String name of the Commit/Branch/Tag. Defaults to 'master'.

                                                                                                                                                                                                                              Headers
                                                                                                                                                                                                                              • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                                                                                                                                                                              • Accept: Is used to set specified media type.
                                                                                                                                                                                                                              • X-RateLimit-Limit:
                                                                                                                                                                                                                              • X-RateLimit-Remaining:
                                                                                                                                                                                                                              • X-RateLimit-Reset:
                                                                                                                                                                                                                              • X-GitHub-Request-Id:
                                                                                                                                                                                                                                • Response

                                                                                                                                                                                                                                • Http Status code
                                                                                                                                                                                                                                  403
                                                                                                                                                                                                                                  API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                                                                                                                                                                                • Http Status code
                                                                                                                                                                                                                                  200
                                                                                                                                                                                                                                • Content-Type: application/json
                                                                                                                                                                                                                                • Example
                                                                                                                                                                                                                                  Schema
                                                                                                                                                                                                                                PUT
                                                                                                                                                                                                                                /repos/{ownerId}/{repoId}/contents/{path}
                                                                                                                                                                                                                                Description

                                                                                                                                                                                                                                Create a file.

                                                                                                                                                                                                                                Request


                                                                                                                                                                                                                                Uri Parameters
                                                                                                                                                                                                                                • path (string )
                                                                                                                                                                                                                                • ownerId (integer )
                                                                                                                                                                                                                                  Id of the owner.
                                                                                                                                                                                                                                • repoId (integer )
                                                                                                                                                                                                                                  Id of repository.

                                                                                                                                                                                                                                Headers
                                                                                                                                                                                                                                • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                                                                                                                                                                                • Accept: Is used to set specified media type.
                                                                                                                                                                                                                                • X-RateLimit-Limit:
                                                                                                                                                                                                                                • X-RateLimit-Remaining:
                                                                                                                                                                                                                                • X-RateLimit-Reset:
                                                                                                                                                                                                                                • X-GitHub-Request-Id:
                                                                                                                                                                                                                                • Content-Type: application/json
                                                                                                                                                                                                                                • Body
                                                                                                                                                                                                                                • Schema
                                                                                                                                                                                                                                • Response

                                                                                                                                                                                                                                • Http Status code
                                                                                                                                                                                                                                  403
                                                                                                                                                                                                                                  API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                                                                                                                                                                                • Http Status code
                                                                                                                                                                                                                                  200
                                                                                                                                                                                                                                • Content-Type: application/json
                                                                                                                                                                                                                                • Example
                                                                                                                                                                                                                                  Schema
                                                                                                                                                                                                                                DELETE
                                                                                                                                                                                                                                /repos/{ownerId}/{repoId}/contents/{path}
                                                                                                                                                                                                                                Description

                                                                                                                                                                                                                                Delete a file. This method deletes a file in a repository.

                                                                                                                                                                                                                                Request


                                                                                                                                                                                                                                Uri Parameters
                                                                                                                                                                                                                                • path (string )
                                                                                                                                                                                                                                • ownerId (integer )
                                                                                                                                                                                                                                  Id of the owner.
                                                                                                                                                                                                                                • repoId (integer )
                                                                                                                                                                                                                                  Id of repository.

                                                                                                                                                                                                                                Headers
                                                                                                                                                                                                                                • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                                                                                                                                                                                • Accept: Is used to set specified media type.
                                                                                                                                                                                                                                • X-RateLimit-Limit:
                                                                                                                                                                                                                                • X-RateLimit-Remaining:
                                                                                                                                                                                                                                • X-RateLimit-Reset:
                                                                                                                                                                                                                                • X-GitHub-Request-Id:
                                                                                                                                                                                                                                • Content-Type: application/json
                                                                                                                                                                                                                                • Body
                                                                                                                                                                                                                                • Schema
                                                                                                                                                                                                                                • Response

                                                                                                                                                                                                                                • Http Status code
                                                                                                                                                                                                                                  403
                                                                                                                                                                                                                                  API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                                                                                                                                                                                • Http Status code
                                                                                                                                                                                                                                  200
                                                                                                                                                                                                                                • Content-Type: application/json
                                                                                                                                                                                                                                • Example
                                                                                                                                                                                                                                  Schema
                                                                                                                                                                                                                                URl: /repos/{ownerId}/{repoId}/{archive_format}/{path}

                                                                                                                                                                                                                                GET
                                                                                                                                                                                                                                /repos/{ownerId}/{repoId}/{archive_format}/{path}
                                                                                                                                                                                                                                Description

                                                                                                                                                                                                                                Get archive link. This method will return a 302 to a URL to download a tarball or zipball archive for a repository. Please make sure your HTTP framework is configured to follow redirects or you will need to use the Location header to make a second GET request. Note: For private repositories, these links are temporary and expire quickly.

                                                                                                                                                                                                                                Request


                                                                                                                                                                                                                                Uri Parameters
                                                                                                                                                                                                                                • archive_format (string )
                                                                                                                                                                                                                                • path (string )
                                                                                                                                                                                                                                  Valid Git reference, defaults to 'master'.
                                                                                                                                                                                                                                • ownerId (integer )
                                                                                                                                                                                                                                  Id of the owner.
                                                                                                                                                                                                                                • repoId (integer )
                                                                                                                                                                                                                                  Id of repository.

                                                                                                                                                                                                                                Headers
                                                                                                                                                                                                                                • X-GitHub-Media-Type: You can check the current version of media type in responses.
                                                                                                                                                                                                                                • Accept: Is used to set specified media type.
                                                                                                                                                                                                                                • X-RateLimit-Limit:
                                                                                                                                                                                                                                • X-RateLimit-Remaining:
                                                                                                                                                                                                                                • X-RateLimit-Reset:
                                                                                                                                                                                                                                • X-GitHub-Request-Id:
                                                                                                                                                                                                                                  • Response

                                                                                                                                                                                                                                  • Http Status code
                                                                                                                                                                                                                                    403
                                                                                                                                                                                                                                    API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details.
                                                                                                                                                                                                                                  • Http Status code
                                                                                                                                                                                                                                    302
                                                                                                                                                                                                                                    Found.
                                                                                                                                                                                                                                  URl: /repos/{ownerId}/{repoId}/downloads

                                                                                                                                                                                                                                  GET
                                                                                                                                                                                                                                  /repos/{ownerId}/{repoId}/downloads
                                                                                                                                                                                                                                  Description

                                                                                                                                                                                                                                  List downloads for a repository.

                                                                                                                                                                                                                                  Request


                                                                                                                                                                                                                                  Uri Parameters
                                                                                                                                                                                                                                  • ownerId (integer )
                                                                                                                                                                                                                                    Id of the owner.
                                                                                                                                                                                                                                  • repoId (integer )
                                                                                                                                                                                                                                    Id of repository.
                                                                                                                                                                                                                                    • Response

                                                                                                                                                                                                                                    • Http Status code
                                                                                                                                                                                                                                      200
                                                                                                                                                                                                                                    • Content-Type: application/json
                                                                                                                                                                                                                                    • Example
                                                                                                                                                                                                                                      Schema
                                                                                                                                                                                                                                    POST
                                                                                                                                                                                                                                    /repos/{ownerId}/{repoId}/downloads
                                                                                                                                                                                                                                    Description

                                                                                                                                                                                                                                    Create a new download (Part 1: Create the resource). For part 2 see http://developer.github.com/v3/repos/downloads/#create-a-new-download-part-2-upload-file-to-s3

                                                                                                                                                                                                                                    Request


                                                                                                                                                                                                                                    Uri Parameters
                                                                                                                                                                                                                                    • ownerId (integer )
                                                                                                                                                                                                                                      Id of the owner.
                                                                                                                                                                                                                                    • repoId (integer )
                                                                                                                                                                                                                                      Id of repository.
                                                                                                                                                                                                                                    • Content-Type: application/json
                                                                                                                                                                                                                                    • Body
                                                                                                                                                                                                                                    • Schema
                                                                                                                                                                                                                                    • Response

                                                                                                                                                                                                                                    • Http Status code
                                                                                                                                                                                                                                      201
                                                                                                                                                                                                                                    • Content-Type: application/json
                                                                                                                                                                                                                                    • Example
                                                                                                                                                                                                                                      Schema
                                                                                                                                                                                                                                    URl: /repos/{ownerId}/{repoId}/downloads/{downloadId}

                                                                                                                                                                                                                                    GET
                                                                                                                                                                                                                                    /repos/{ownerId}/{repoId}/downloads/{downloadId}
                                                                                                                                                                                                                                    Description

                                                                                                                                                                                                                                    Get a single download.

                                                                                                                                                                                                                                    Request


                                                                                                                                                                                                                                    Uri Parameters
                                                                                                                                                                                                                                    • downloadId (integer )
                                                                                                                                                                                                                                      Id of the download.
                                                                                                                                                                                                                                    • ownerId (integer )
                                                                                                                                                                                                                                      Id of the owner.
                                                                                                                                                                                                                                    • repoId (integer )
                                                                                                                                                                                                                                      Id of repository.
                                                                                                                                                                                                                                      • Response

                                                                                                                                                                                                                                      • Http Status code
                                                                                                                                                                                                                                        200
                                                                                                                                                                                                                                      • Content-Type: application/json
                                                                                                                                                                                                                                      • Schema
                                                                                                                                                                                                                                      DELETE
                                                                                                                                                                                                                                      /repos/{ownerId}/{repoId}/downloads/{downloadId}
                                                                                                                                                                                                                                      Description

                                                                                                                                                                                                                                      Delete a download.

                                                                                                                                                                                                                                      Request


                                                                                                                                                                                                                                      Uri Parameters
                                                                                                                                                                                                                                      • downloadId (integer )
                                                                                                                                                                                                                                        Id of the download.
                                                                                                                                                                                                                                      • ownerId (integer )
                                                                                                                                                                                                                                        Id of the owner.
                                                                                                                                                                                                                                      • repoId (integer )
                                                                                                                                                                                                                                        Id of repository.
                                                                                                                                                                                                                                        • Response

                                                                                                                                                                                                                                        • Http Status code
                                                                                                                                                                                                                                          204
                                                                                                                                                                                                                                          Item removed.
                                                                                                                                                                                                                                        URl: /repos/{ownerId}/{repoId}/forks

                                                                                                                                                                                                                                        GET
                                                                                                                                                                                                                                        /repos/{ownerId}/{repoId}/forks
                                                                                                                                                                                                                                        Description

                                                                                                                                                                                                                                        List forks.

                                                                                                                                                                                                                                        Request


                                                                                                                                                                                                                                        Uri Parameters
                                                                                                                                                                                                                                        • ownerId (integer )
                                                                                                                                                                                                                                          Id of the owner.
                                                                                                                                                                                                                                        • repoId (integer )
                                                                                                                                                                                                                                          Id of repository.

                                                                                                                                                                                                                                        Query parameters
                                                                                                                                                                                                                                        • sort (string )
                                                                                                                                                                                                                                          • Response

                                                                                                                                                                                                                                          • Http Status code
                                                                                                                                                                                                                                            200
                                                                                                                                                                                                                                          • Content-Type: application/json
                                                                                                                                                                                                                                          • Example
                                                                                                                                                                                                                                            Schema