Jump to >

Hosting Service List Resource

Added in 2.5

Provides information on registered hosting services.

Review Board has a list of supported remote hosting services for repositories and bug trackers. These hosting services contain the information needed for Review Board to link with any repositories hosted on that service and access content for display in the diff viewer.

This resource allows for querying that list and determining what capabilities of the hosting service can be used by Review Board.

Details

Name hosting_services
URI /api/hosting-services/
Token Policy ID hosting_service
HTTP Methods
  • GET - Lists all the hosting services supported by Review Board.
Parent Resource Root List Resource
Child Resources
Anonymous Access Yes, if anonymous site access is enabled

HTTP GET

Lists all the hosting services supported by Review Board.

Unlike most resources, this will not be paginated. The number of hosting services will be small, and it’s useful to get them all in one request.

Request Parameters

counts-onlyBoolean If specified, a single count field is returned with the number of results, instead of the results themselves.
max-resultsInteger The maximum number of results to return in this list. By default, this is 25. There is a hard limit of 200; if you need more than 200 results, you will need to make more than one request, using the “next” pagination link.
startInteger The 0-based index of the first result in the list. The start index is usually the previous start index plus the number of previous results. By default, this is 0.

Errors

100 - Does Not ExistHTTP 404 - Not Found Object does not exist
101 - Permission DeniedHTTP 403 - Forbidden You don’t have permission for this
103 - Not Logged InHTTP 401 - Unauthorized You are not logged in
105 - Invalid Form DataHTTP 400 - Bad Request One or more fields had errors
112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden Your OAuth2 token lacks the necessary scopes for this request.
113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden OAuth2 token access for this resource is prohibited.

Examples

application/vnd.reviewboard.org.hosting-services+json

$ curl http://reviews.example.com/api -H "Accept: application/json"
Vary: Accept, Cookie
Item-Content-Type: application/vnd.reviewboard.org.hosting-service+json
Content-Type: application/vnd.reviewboard.org.hosting-services+json
ETag: 85821ef90f3a6cc0c2c5f3c962294c7626b6f85a
X-Content-Type-Options: nosniff
{
  "hosting_services": [
    {
      "id": "gitorious", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=gitorious", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=gitorious", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/gitorious/", 
          "method": "GET"
        }
      }, 
      "name": "Gitorious", 
      "needs_authorization": false, 
      "self_hosted": true, 
      "supported_scmtools": [
        "Git"
      ], 
      "supports_bug_trackers": false, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": true, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": [
        "Git"
      ]
    }, 
    {
      "id": "splat", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=splat", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=splat", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/splat/", 
          "method": "GET"
        }
      }, 
      "name": "Splat", 
      "needs_authorization": false, 
      "self_hosted": false, 
      "supported_scmtools": [], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": false, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": []
    }, 
    {
      "id": "versionone", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=versionone", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=versionone", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/versionone/", 
          "method": "GET"
        }
      }, 
      "name": "VersionOne", 
      "needs_authorization": false, 
      "self_hosted": false, 
      "supported_scmtools": [], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": false, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": []
    }, 
    {
      "id": "redmine", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=redmine", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=redmine", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/redmine/", 
          "method": "GET"
        }
      }, 
      "name": "Redmine", 
      "needs_authorization": false, 
      "self_hosted": false, 
      "supported_scmtools": [], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": false, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": []
    }, 
    {
      "id": "unfuddle", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=unfuddle", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=unfuddle", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/unfuddle/", 
          "method": "GET"
        }
      }, 
      "name": "Unfuddle", 
      "needs_authorization": true, 
      "self_hosted": false, 
      "supported_scmtools": [
        "Git", 
        "Subversion"
      ], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": true, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": [
        "Git", 
        "Subversion"
      ]
    }, 
    {
      "id": "gerrit", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=gerrit", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=gerrit", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/gerrit/", 
          "method": "GET"
        }
      }, 
      "name": "Gerrit", 
      "needs_authorization": true, 
      "self_hosted": false, 
      "supported_scmtools": [
        "Git"
      ], 
      "supports_bug_trackers": false, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": true, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": [
        "Git"
      ]
    }, 
    {
      "id": "bitbucket", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=bitbucket", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=bitbucket", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/bitbucket/", 
          "method": "GET"
        }
      }, 
      "name": "Bitbucket", 
      "needs_authorization": true, 
      "self_hosted": false, 
      "supported_scmtools": [
        "Git", 
        "Mercurial"
      ], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": true, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": [
        "Git", 
        "Mercurial"
      ]
    }, 
    {
      "id": "kiln", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=kiln", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=kiln", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/kiln/", 
          "method": "GET"
        }
      }, 
      "name": "Kiln On Demand", 
      "needs_authorization": true, 
      "self_hosted": false, 
      "supported_scmtools": [
        "Git", 
        "Mercurial"
      ], 
      "supports_bug_trackers": false, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": true, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": [
        "Git", 
        "Mercurial"
      ]
    }, 
    {
      "id": "rbgateway", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=rbgateway", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=rbgateway", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/rbgateway/", 
          "method": "GET"
        }
      }, 
      "name": "Review Board Gateway", 
      "needs_authorization": true, 
      "self_hosted": true, 
      "supported_scmtools": [
        "Git", 
        "Mercurial"
      ], 
      "supports_bug_trackers": false, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": true, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": [
        "Git", 
        "Mercurial"
      ]
    }, 
    {
      "id": "codebasehq", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=codebasehq", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=codebasehq", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/codebasehq/", 
          "method": "GET"
        }
      }, 
      "name": "Codebase HQ", 
      "needs_authorization": true, 
      "self_hosted": false, 
      "supported_scmtools": [
        "Git", 
        "Subversion", 
        "Mercurial"
      ], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": true, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": [
        "Git", 
        "Subversion", 
        "Mercurial"
      ]
    }, 
    {
      "id": "fogbugz", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=fogbugz", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=fogbugz", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/fogbugz/", 
          "method": "GET"
        }
      }, 
      "name": "FogBugz", 
      "needs_authorization": false, 
      "self_hosted": false, 
      "supported_scmtools": [], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": false, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": []
    }, 
    {
      "id": "sourceforge", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=sourceforge", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=sourceforge", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/sourceforge/", 
          "method": "GET"
        }
      }, 
      "name": "SourceForge", 
      "needs_authorization": false, 
      "self_hosted": false, 
      "supported_scmtools": [
        "Bazaar", 
        "CVS", 
        "Mercurial", 
        "Subversion"
      ], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": true, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": [
        "Bazaar", 
        "CVS", 
        "Mercurial", 
        "Subversion"
      ]
    }, 
    {
      "id": "assembla", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=assembla", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=assembla", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/assembla/", 
          "method": "GET"
        }
      }, 
      "name": "Assembla", 
      "needs_authorization": true, 
      "self_hosted": false, 
      "supported_scmtools": [
        "Perforce", 
        "Subversion"
      ], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": true, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": [
        "Perforce", 
        "Subversion"
      ]
    }, 
    {
      "id": "fedorahosted", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=fedorahosted", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=fedorahosted", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/fedorahosted/", 
          "method": "GET"
        }
      }, 
      "name": "Fedora Hosted", 
      "needs_authorization": false, 
      "self_hosted": false, 
      "supported_scmtools": [
        "Git", 
        "Mercurial", 
        "Subversion"
      ], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": true, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": [
        "Git", 
        "Mercurial", 
        "Subversion"
      ]
    }, 
    {
      "id": "gitlab", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=gitlab", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=gitlab", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/gitlab/", 
          "method": "GET"
        }
      }, 
      "name": "GitLab", 
      "needs_authorization": true, 
      "self_hosted": true, 
      "supported_scmtools": [
        "Git"
      ], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": true, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": [
        "Git"
      ]
    }, 
    {
      "id": "beanstalk", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=beanstalk", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=beanstalk", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/beanstalk/", 
          "method": "GET"
        }
      }, 
      "name": "Beanstalk", 
      "needs_authorization": true, 
      "self_hosted": false, 
      "supported_scmtools": [
        "Git", 
        "Subversion"
      ], 
      "supports_bug_trackers": false, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": true, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": [
        "Git", 
        "Subversion"
      ]
    }, 
    {
      "id": "googlecode", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=googlecode", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=googlecode", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/googlecode/", 
          "method": "GET"
        }
      }, 
      "name": "Google Code", 
      "needs_authorization": false, 
      "self_hosted": false, 
      "supported_scmtools": [
        "Mercurial", 
        "Subversion"
      ], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": true, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": [
        "Mercurial", 
        "Subversion"
      ]
    }, 
    {
      "id": "github", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=github", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=github", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/github/", 
          "method": "GET"
        }
      }, 
      "name": "GitHub", 
      "needs_authorization": true, 
      "self_hosted": false, 
      "supported_scmtools": [
        "Git"
      ], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": true, 
      "supports_repositories": true, 
      "supports_two_factor_auth": true, 
      "visible_scmtools": [
        "Git"
      ]
    }, 
    {
      "id": "bugzilla", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=bugzilla", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=bugzilla", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/bugzilla/", 
          "method": "GET"
        }
      }, 
      "name": "Bugzilla", 
      "needs_authorization": false, 
      "self_hosted": false, 
      "supported_scmtools": [], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": false, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": []
    }, 
    {
      "id": "trac", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=trac", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=trac", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/trac/", 
          "method": "GET"
        }
      }, 
      "name": "Trac", 
      "needs_authorization": false, 
      "self_hosted": false, 
      "supported_scmtools": [], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": false, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": []
    }, 
    {
      "id": "jira", 
      "links": {
        "accounts": {
          "href": "http://reviews.example.com/api/hosting-service-accounts/?service=jira", 
          "method": "GET"
        }, 
        "repositories": {
          "href": "http://reviews.example.com/api/repositories/?hosting-service=jira", 
          "method": "GET"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/hosting-services/jira/", 
          "method": "GET"
        }
      }, 
      "name": "JIRA", 
      "needs_authorization": false, 
      "self_hosted": false, 
      "supported_scmtools": [], 
      "supports_bug_trackers": true, 
      "supports_list_remote_repositories": false, 
      "supports_repositories": false, 
      "supports_two_factor_auth": false, 
      "visible_scmtools": []
    }
  ], 
  "links": {
    "self": {
      "href": "http://reviews.example.com/api", 
      "method": "GET"
    }
  }, 
  "stat": "ok", 
  "total_results": 21
}