Travis CI

About Travis CI

Travis CI provides a REST API (V2, being superseded by V3) for interacting with its continuous integration service. The API covers repositories, builds, branches, jobs, and requests, with separate endpoints for open source projects (api.travis-ci.org), private projects (api.travis-ci.com), and self-hosted Travis CI Enterprise installations. Authentication is handled by exchanging a GitHub token for a Travis CI access token via the /auth/github endpoint; users must first log in through the web interface before this exchange is possible.

The API integrates with GitHub as its source of users, organizations, and repositories, and with Pusher for streaming build logs live. A /config endpoint exposes connection details for these external services, including the GitHub API endpoint, required GitHub OAuth scopes, and the Pusher application key. Enterprise setups behind a firewall can also use Slanger, whose URL is likewise exposed through /config.

This documentation is aimed at developers building custom clients or tools against the Travis CI API, such as CI dashboards, command-line tools, or integrations. Client libraries exist for Ruby (the travis gem, with Travis::Client and Travis::Pro namespaces) and a command-line client (travis). Requests must set a User-Agent header and an Accept header specifying the API version (application/vnd.travis-ci.2.1+json for V2.1).

Key features

• Authenticate by exchanging a GitHub token for a Travis access token via /auth/github
• Config endpoint exposes GitHub API URL, required OAuth scopes, and Pusher key for live log streaming
• Command-line client (travis) and Ruby client library for interacting with the API
• API V2.1 adds more consistent HTTP status codes across travis-ci.org and travis-ci.com

Frequently asked questions