Travis CI API 文档

Cron

单个 cron。每个仓库的每个分支只能有一个 cron。

如果使用仓库 Slug 查询,则必须使用 标准 URL 编码 格式化,包括任何特殊字符。

属性

最小表示

当资源作为另一个资源的一部分返回时包含。

名称类型描述
id整数唯一标识 cron 的值。

标准表示

当资源是请求的主要响应,或 预加载 时包含。

名称类型描述
id整数唯一标识 cron 的值。
repository仓库此 cron 所属的 GitHub 仓库。
branch分支此 cron 所属的仓库的 Git 分支。
interval字符串cron 运行的间隔(可以是“daily”、“weekly”或“monthly”)。
dont_run_if_recent_build_exists布尔值如果在过去 24 小时内此分支上存在构建,是否应该运行 cron 构建。
last_run字符串cron 上次运行的时间。
next_run字符串cron 预计下次运行的时间。
created_at字符串cron 创建时间。
active未知cron 的 active。

操作

查找

这将返回单个 cron。

GET
/cron/{cron.id}
模板变量类型描述
cron.id整数唯一标识 cron 的值。
查询参数类型描述
include[字符串]预加载 的属性列表。

删除

这将删除单个 cron。

DELETE
/cron/{cron.id}
模板变量类型描述
cron.id整数唯一标识 cron 的值。

对于分支

这将返回为指定仓库的指定分支设置的 cron。可以在请求中使用仓库 ID 或 Slug。

GET
/repo/{provider}/{repository.id}/branch/{branch.name}/cron
模板变量类型描述
provider未知文档缺失。
repository.id整数唯一标识仓库的值。
branch.name字符串Git 分支的名称。
查询参数类型描述
include[字符串]预加载 的属性列表。
GET
/repo/{provider}/{repository.slug}/branch/{branch.name}/cron
模板变量类型描述
provider未知文档缺失。
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
branch.name字符串Git 分支的名称。
查询参数类型描述
include[字符串]预加载 的属性列表。
GET
/repo/{repository.id}/branch/{branch.name}/cron
模板变量类型描述
repository.id整数唯一标识仓库的值。
branch.name字符串Git 分支的名称。
查询参数类型描述
include[字符串]预加载 的属性列表。

示例GET /repo/891/branch/master/cron

GET
/repo/{repository.slug}/branch/{branch.name}/cron
模板变量类型描述
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
branch.name字符串Git 分支的名称。
查询参数类型描述
include[字符串]预加载 的属性列表。

示例GET /repo/rails%2Frails/branch/master/cron

创建

这将在指定仓库的指定分支上创建 cron。可以在请求中使用仓库 ID 或 Slug。Content-Type 必须在标头中设置,并且必须指定 cron 的间隔作为参数。

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  -d '{ "cron.interval": "monthly" }' \
  https://api.travis-ci.com/repo/1234/branch/master/cron
POST
/repo/{provider}/{repository.id}/branch/{branch.name}/cron
模板变量类型描述
provider未知文档缺失。
repository.id整数唯一标识仓库的值。
branch.name字符串Git 分支的名称。
接受的参数类型描述
cron.interval字符串cron 运行的间隔(可以是“daily”、“weekly”或“monthly”)。
cron.dont_run_if_recent_build_exists布尔值如果在过去 24 小时内此分支上存在构建,是否应该运行 cron 构建。
POST
/repo/{provider}/{repository.slug}/branch/{branch.name}/cron
模板变量类型描述
provider未知文档缺失。
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
branch.name字符串Git 分支的名称。
接受的参数类型描述
cron.interval字符串cron 运行的间隔(可以是“daily”、“weekly”或“monthly”)。
cron.dont_run_if_recent_build_exists布尔值如果在过去 24 小时内此分支上存在构建,是否应该运行 cron 构建。
POST
/repo/{repository.id}/branch/{branch.name}/cron
模板变量类型描述
repository.id整数唯一标识仓库的值。
branch.name字符串Git 分支的名称。
接受的参数类型描述
cron.interval字符串cron 运行的间隔(可以是“daily”、“weekly”或“monthly”)。
cron.dont_run_if_recent_build_exists布尔值如果在过去 24 小时内此分支上存在构建,是否应该运行 cron 构建。

示例POST /repo/891/branch/master/cron

POST
/repo/{repository.slug}/branch/{branch.name}/cron
模板变量类型描述
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
branch.name字符串Git 分支的名称。
接受的参数类型描述
cron.interval字符串cron 运行的间隔(可以是“daily”、“weekly”或“monthly”)。
cron.dont_run_if_recent_build_exists布尔值如果在过去 24 小时内此分支上存在构建,是否应该运行 cron 构建。

示例POST /repo/rails%2Frails/branch/master/cron