Travis CI API 文档

环境变量

单个环境变量。

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

属性

标准表示

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

名称类型描述
id字符串环境变量 ID。
name字符串环境变量名称,例如 FOO。
value字符串环境变量的值,例如 bar。
public布尔值此环境变量是否应公开可见。
branch未知env_var 的分支。

最小表示

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

名称类型描述
id字符串环境变量 ID。
name字符串环境变量名称,例如 FOO。
public布尔值此环境变量是否应公开可见。
branch未知env_var 的分支。

操作

查找

这将返回单个环境变量。可以在请求中使用仓库 ID 或标识。

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

更新

这将更新单个环境变量。可以在请求中使用仓库 ID 或标识。

在请求主体中使用命名空间参数传递新的环境变量

curl -X PATCH \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  -d '{ "env_var.value": "bar", "env_var.public": false }' \
  https://api.travis-ci.com/repo/1234/env_var/{env_var.id}
PATCH
/repo/{provider}/{repository.id}/env_var/{env_var.id}
模板变量类型描述
provider未知文档缺失。
repository.id整数唯一标识仓库的值。
env_var.id字符串环境变量 ID。
接受的参数类型描述
env_var.name字符串环境变量名称,例如 FOO。
env_var.value字符串环境变量的值,例如 bar。
env_var.public布尔值此环境变量是否应公开可见。
env_var.branch未知env_var 的分支。
PATCH
/repo/{provider}/{repository.slug}/env_var/{env_var.id}
模板变量类型描述
provider未知文档缺失。
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
env_var.id字符串环境变量 ID。
接受的参数类型描述
env_var.name字符串环境变量名称,例如 FOO。
env_var.value字符串环境变量的值,例如 bar。
env_var.public布尔值此环境变量是否应公开可见。
env_var.branch未知env_var 的分支。
PATCH
/repo/{repository.id}/env_var/{env_var.id}
模板变量类型描述
repository.id整数唯一标识仓库的值。
env_var.id字符串环境变量 ID。
接受的参数类型描述
env_var.name字符串环境变量名称,例如 FOO。
env_var.value字符串环境变量的值,例如 bar。
env_var.public布尔值此环境变量是否应公开可见。
env_var.branch未知env_var 的分支。
PATCH
/repo/{repository.slug}/env_var/{env_var.id}
模板变量类型描述
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
env_var.id字符串环境变量 ID。
接受的参数类型描述
env_var.name字符串环境变量名称,例如 FOO。
env_var.value字符串环境变量的值,例如 bar。
env_var.public布尔值此环境变量是否应公开可见。
env_var.branch未知env_var 的分支。

删除

这将删除单个环境变量。可以在请求中使用仓库 ID 或标识。

DELETE
/repo/{provider}/{repository.id}/env_var/{env_var.id}
模板变量类型描述
provider未知文档缺失。
repository.id整数唯一标识仓库的值。
env_var.id字符串环境变量 ID。
DELETE
/repo/{provider}/{repository.slug}/env_var/{env_var.id}
模板变量类型描述
provider未知文档缺失。
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
env_var.id字符串环境变量 ID。
DELETE
/repo/{repository.id}/env_var/{env_var.id}
模板变量类型描述
repository.id整数唯一标识仓库的值。
env_var.id字符串环境变量 ID。
DELETE
/repo/{repository.slug}/env_var/{env_var.id}
模板变量类型描述
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
env_var.id字符串环境变量 ID。