Travis CI API Docs

Settings

A list of user settings. These are settings on a repository that can be adjusted by the user. There are currently six different kinds of user settings:

  • builds_only_with_travis_yml (boolean)
  • build_pushes (boolean)
  • build_pull_requests (boolean)
  • maximum_number_of_builds (integer)
  • auto_cancel_pushes (boolean)
  • auto_cancel_pull_requests (boolean)

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

Attributes

NameTypeDescription
settings[Setting]List of settings.

Collection Items

Each entry in the settings array has the following attributes:

NameTypeDescription
nameStringThe setting's name.
valueBoolean or integerThe setting's value.

Actions

For Repository

This returns a list of the settings for that repository. It is possible to use the repository id or slug in the request.

GET
/repo/{provider}/{repository.id}/settings
Template VariableTypeDescription
providerUnknownDocumentation missing.
repository.idIntegerValue uniquely identifying the repository.
Query ParameterTypeDescription
include[String]List of attributes to eager load.
GET
/repo/{provider}/{repository.slug}/settings
Template VariableTypeDescription
providerUnknownDocumentation missing.
repository.slugStringSame as {repository.owner.name}/{repository.name}.
Query ParameterTypeDescription
include[String]List of attributes to eager load.
GET
/repo/{repository.id}/settings
Template VariableTypeDescription
repository.idIntegerValue uniquely identifying the repository.
Query ParameterTypeDescription
include[String]List of attributes to eager load.

Example:GET /repo/891/settings

GET
/repo/{repository.slug}/settings
Template VariableTypeDescription
repository.slugStringSame as {repository.owner.name}/{repository.name}.
Query ParameterTypeDescription
include[String]List of attributes to eager load.

Example:GET /repo/rails%2Frails/settings