Travis CI API Docs

Requests

A list of requests.

If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.

Attributes

Collection Items

Each entry in the requests array has the following attributes:

Actions

Find

This will return a list of requests belonging to a repository.

Example:GET /repo/891/requests?limit=5

Example:GET /repo/rails%2Frails/requests?limit=5

Create

This will create a request for an individual repository, triggering a build to run on Travis CI.

Use namespaced params in JSON format in the request body to pass any accepted parameters. Any keys in the request's config will override keys existing in the .travis.yml.

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  -d '{ "request": {
        "message": "Override the commit message: this is an api request", "branch": "master" }}'\
  https://api.travis-ci.com/repo/1/requests

The response includes the following body:

{
  "@type":              "pending",
  "remaining_requests": 1,
  "repository":         {
    "@type":            "repository",
    "@href":            "/repo/1",
    "@representation":  "minimal",
    "id":               1,
    "name":             "test",
    "slug":             "owner/repo"
  },
  "request":            {
    "repository":       {
      "id":             1,
      "owner_name":     "owner",
      "name":           "repo"
    },
    "user":             {
      "id":             1
    },
    "id":               1,
    "message":          "Override the commit message: this is an api request",
    "branch":           "master",
    "config":           { }
  },
  "resource_type":      "request"
}

Example:POST /repo/891/requests

Example:POST /repo/rails%2Frails/requests