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
Name | Type | Description |
---|---|---|
settings | [Setting] | List of settings. |
Collection Items
Each entry in the settings array has the following attributes:
Name | Type | Description |
---|---|---|
name | String | The setting's name. |
value | Boolean or integer | The 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 Variable | Type | Description |
---|---|---|
provider | Unknown | Documentation missing. |
repository.id | Integer | Value uniquely identifying the repository. |
Query Parameter | Type | Description |
---|---|---|
include | [String] | List of attributes to eager load. |
GET
/repo/{provider}/{repository.slug}/settings
Template Variable | Type | Description |
---|---|---|
provider | Unknown | Documentation missing. |
repository.slug | String | Same as {repository.owner.name}/{repository.name}. |
Query Parameter | Type | Description |
---|---|---|
include | [String] | List of attributes to eager load. |
GET
/repo/{repository.id}/settings
Template Variable | Type | Description |
---|---|---|
repository.id | Integer | Value uniquely identifying the repository. |
Query Parameter | Type | Description |
---|---|---|
include | [String] | List of attributes to eager load. |
Example:GET /repo/891/settings
GET
/repo/{repository.slug}/settings
Template Variable | Type | Description |
---|---|---|
repository.slug | String | Same as {repository.owner.name}/{repository.name}. |
Query Parameter | Type | Description |
---|---|---|
include | [String] | List of attributes to eager load. |
Example:GET /repo/rails%2Frails/settings