Travis CI API 文档

密钥对

用户可以将公钥/私钥 RSA 密钥对添加到存储库中。
这可以在构建中使用,例如访问第三方服务或将代码部署到生产环境。
请注意,此功能仅在 travis-ci.com 域上可用。

属性

标准表示

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

名称类型描述
description字符串文本描述。
public_key字符串公钥。
fingerprint字符串指纹。

最小表示

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

名称类型描述
description字符串文本描述。
public_key字符串公钥。
fingerprint字符串指纹。

操作

查找

返回当前密钥对(如果存在)。

GET
/repo/{provider}/{repository.id}/key_pair
模板变量类型描述
provider未知文档丢失。
repository.id整数唯一标识存储库的值。
查询参数类型描述
include[字符串]急切加载 的属性列表。
GET
/repo/{provider}/{repository.slug}/key_pair
模板变量类型描述
provider未知文档丢失。
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
查询参数类型描述
include[字符串]急切加载 的属性列表。
GET
/repo/{repository.id}/key_pair
模板变量类型描述
repository.id整数唯一标识存储库的值。
查询参数类型描述
include[字符串]急切加载 的属性列表。

示例GET /repo/891/key_pair

GET
/repo/{repository.slug}/key_pair
模板变量类型描述
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
查询参数类型描述
include[字符串]急切加载 的属性列表。

示例GET /repo/rails%2Frails/key_pair

创建

创建一个新的密钥对。

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  -d '{ "key_pair.description": "FooBar", "key_pair.value": "xxxxx"}' \
  https://api.travis-ci.com/repo/1234/key_pair
POST
/repo/{provider}/{repository.id}/key_pair
模板变量类型描述
provider未知文档丢失。
repository.id整数唯一标识存储库的值。
接受的参数类型描述
key_pair.description字符串文本描述。
key_pair.value字符串私钥。
POST
/repo/{provider}/{repository.slug}/key_pair
模板变量类型描述
provider未知文档丢失。
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
接受的参数类型描述
key_pair.description字符串文本描述。
key_pair.value字符串私钥。
POST
/repo/{repository.id}/key_pair
模板变量类型描述
repository.id整数唯一标识存储库的值。
接受的参数类型描述
key_pair.description字符串文本描述。
key_pair.value字符串私钥。

示例POST /repo/891/key_pair

POST
/repo/{repository.slug}/key_pair
模板变量类型描述
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
接受的参数类型描述
key_pair.description字符串文本描述。
key_pair.value字符串私钥。

示例POST /repo/rails%2Frails/key_pair

更新

更新密钥对。

curl -X PATCH \
  -H "Content-Type: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token xxxxxxxxxxxx" \
  -d '{ "key_pair.description": "FooBarBaz" }' \
  https://api.travis-ci.com/repo/1234/key_pair
PATCH
/repo/{provider}/{repository.id}/key_pair
模板变量类型描述
provider未知文档丢失。
repository.id整数唯一标识存储库的值。
接受的参数类型描述
key_pair.description字符串文本描述。
key_pair.value字符串私钥。
PATCH
/repo/{provider}/{repository.slug}/key_pair
模板变量类型描述
provider未知文档丢失。
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
接受的参数类型描述
key_pair.description字符串文本描述。
key_pair.value字符串私钥。
PATCH
/repo/{repository.id}/key_pair
模板变量类型描述
repository.id整数唯一标识存储库的值。
接受的参数类型描述
key_pair.description字符串文本描述。
key_pair.value字符串私钥。

示例PATCH /repo/891/key_pair

PATCH
/repo/{repository.slug}/key_pair
模板变量类型描述
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。
接受的参数类型描述
key_pair.description字符串文本描述。
key_pair.value字符串私钥。

示例PATCH /repo/rails%2Frails/key_pair

删除

删除密钥对。

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

示例DELETE /repo/891/key_pair

DELETE
/repo/{repository.slug}/key_pair
模板变量类型描述
repository.slug字符串与 {repository.owner.name}/{repository.name} 相同。

示例DELETE /repo/rails%2Frails/key_pair