纳税Navbar.

Circleci V1 API概述

circleciapi是一个功能齐全的restfulapi,允许您访问CircleCI中的所有信息并触发所有操作。RESTful API使您能够调用各个API端点来执行以下操作:

速率限制

Circleci API受许多速率限制措施来保护,以确保系统的稳定性。我们保留了扼杀个人用户所提出的请求的权利,或者对各个资源所做的请求,以确保对我们所有用户提供公平的服务水平。

由于API与Circleci集成的作者,您的集成应该期望令人盗贼,并且应该能够优雅地处理失败。API的不同部位有不同的保护和限制。特别是,我们保护我们的API反对突如其来的车流,我们保护持续高卷例如,常常投票的要求。

对于HTTP API,当请求时,您将收到HTTP状态代码429。如果您的集成要求已完成限制性请求,则使用指数退避,您应该在延迟后重试这些请求。在大多数情况下,HTTP 429响应代码将伴随HTTP头后重试。当存在此标题时,在重试请求之前,您的集成应该等待标题值指定的时间段。

API语法

进行API请求时,请确保遵循标准REST API语法和格式。遵守正确的REST API语法可确保API服务器可以正确地处理您的请求并返回JSON响应。要对Circleci API进行请求,请使用窗格中显示的格式到右侧:

"//www.drag240sx.com/api/v1.1"

在哪里:

身份验证

CircleCI API利用基于令牌的身份验证来管理对API服务器的访问,并验证用户是否有权发出API请求。在发出API请求之前,必须先添加API令牌,然后验证API服务器是否对您进行了身份验证,才能发出请求。下面几节将介绍添加API令牌并让API服务器对您进行身份验证的过程。

笔记通过传递,您可以使用API​​令牌作为HTTP基本身份验证的用户名-U旗帜到卷曲命令。

添加API令牌

$卷曲-H“循环令牌://www.drag240sx.com/api/v1.1/me
{“用户密钥\u指纹”空值“days_left_in_trial”-238“计划”“p16”“trial_end”“2011-12-28 22:02:15Z”“basic_email_prefs”“聪明”“行政”真的“登录”“pbiggar”}

要添加API令牌,请执行下面列出的步骤。

  1. 从应用程序中添加API令牌帐户仪表板
  2. 测试它,在浏览器中查看它或使用api使用
  3. 您应该会看到类似于右窗格中所示示例的响应。

获得身份验证

卷曲-H“循环令牌:“https://www.drag240sx.com/api / ......”
卷曲-u“https://www.drag240sx.com/api / ......”
卷曲"//www.drag240sx.com/api/v1.1/me?圆圈标记=

您可以使用您的API标记添加API令牌帐户仪表板

要通过API服务器进行身份验证,请将其用作Circle令牌头的值:

或者您可以通过传递-U旗帜到卷曲命令:

已弃用(此选项将来将被删除):可以将API令牌添加到圈子令牌查询参数:

版本控制系统(:VCS型)

卷曲//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/tree/: branch.

具有API的v1.1的新项目,用于端点/项目,您现在需要告诉Circleci版本控制系统类型您的项目使用。您目前可能选择“GitHub”或“Bitbucket”。项目的最新构建命令将格式化,如右窗格中显示的示例。

F / OSS.

如果你有免费/开源软件(F / OSS)项目,并在项目仪表板的高级设置中启用该设置,则某些只读/项目终结点将返回请求的数据,而不需要令牌。人们还可以查看项目的构建结果仪表板。

列表排序

(//www.drag240sx.com/docs/api/v1-reference/#recent-builds)(//www.drag240sx.com/docs/api/v1-reference/#recent-builds-project)

列表订单有两个API端点:

在这两种情况下,构建按照创建的顺序返回。对于所有其他端点,订单没有特殊的意义。

文件接受点

卷曲//www.drag240sx.com/api/v1.1/me-小时“接受:application / json”-H“循环令牌:

如果未指定接受标题(或者它为空),则Circleci将以Clojure EDN格式返回数据。要接收与格式化的JSON的数据,包括任何值接受收割台(例如文本/纯文本)。如果您愿意接收没有空格或评论的Compact JSON,请使用应用程序/json作为接受标题。

入门

CIRCLECI 1.0和2.0由API 1.1版支持如下文档:

API终结点摘要

所有Circleci API端点都开始//www.drag240sx.com/api/v1.1//

获取请求

API. 说明
/我 提供有关用户签名的信息。
/项目 列出您在Circleci上关注的所有项目,构建由分支组织的构建信息。
/项目/:vcs-type /:用户名/:项目 为单个Git Repo中每个版本的每个构建返回构建摘要。
/最近建立 返回最近30个生成中每个生成的生成摘要,按生成数量排序。
/项目/:vcs-type /:用户名/:project /:build_num 返回单个构建的完整详细信息。该响应包括来自构建摘要的所有字段。这也是有效载荷通知webhooks,在这种情况下,此对象是指向“有效载荷”密钥的值。
/项目/:vcs类型/:用户名/:项目/:生成数量/工件 列出由给定构建生成的工件。
/项目/:vcs类型/:用户名/:项目/签出键/:指纹 检索结账键。

发布请求

API. 说明
/项目/:vcs类型/:用户名/:项目/跟随 关注CircleCI的一个新项目。
/project/:vcs type/:username/:project/:build\u num/重试 重试构建,返回新版本的摘要。
/项目/:vcs-type /:用户名/:project /:build_num /取消 取消构建,返回构建的摘要。
/项目/:vcs-type /:用户名/:project /:build_num / ssh-users 将用户添加到Build的SSH权限。
/项目/:vcs-type /:用户名/:project /树/:分支 触发新生成,返回生成的摘要。可选1.0构建参数也可以设置,可选2.0构建参数
/项目/:vcs类型/:用户名/:项目/ssh密钥 创建用于访问需要SSH基于键的身份验证的外部系统的SSH密钥。
/项目/:vcs-type /:用户名/:project / checkout-key 创建一个新的结账键。

删除请求

API. 说明
/项目/:vcs类型/:用户名/:项目/签出键/:指纹 删除签出键。
/项目/:vcs类型/:用户名/:项目/生成缓存 清除项目的缓存。
/项目/:vcs类型/:用户名/:项目/ssh密钥 从项目中删除SSH密钥。

用户

卷曲//www.drag240sx.com/api/v1.1/me-小时“循环令牌:
{“basic_email_prefs”“聪明”//可以“聪明”“没有”或者“全部”“登录”“pbiggar”//你的GitHub.用户名}

得到请求:提供有关当前登录的用户的信息。

项目

如果您想检索有关项目的详细信息,CircleCI提供了几个不同的端点,您可以调用这些端点来返回这些信息,包括返回所有项目的详细信息的功能。为了确保在发出API请求时不会遇到任何与性能相关的延迟或问题,您可能希望限制对单个项目的搜索,而不是对项目数组的搜索。

下面的部分描述了您可以调用返回项目信息的端点。

获取所有关注的项目

卷曲//www.drag240sx.com/api/v1.1/projects-小时“循环令牌:
[{“vcs_url”“https://github.com/circleci/mongofinil”“跟踪”真的//真的如果跟随项目圆环“用户名”“循环”“reponame”“蒙哥菲尔”“分支机构”{“掌握”{“pusher_logins”[“pbiggar”“阿罗纳”],//用户“last_non_success”{//最后的失败建造分支“pushed_at”“2013-02-12T21:33:14Z”“vcs_revision”“1D231626BA1D2838E599C5C598D28E2306AD4E48”“build_num”22.“结果”“失败的”},“上次成功”{//最后的成功的建造分支“pushed_at”“2012-08-09T03:59:53z”“vcs_revision”“384211BBE72B2A22997116A78788117B3922D570”“build_num”15.“结果”“成功”},“最近_Builds”[{//最后的5.建立订购经过pushed_at.(减少)“pushed_at”“2013-02-12T21:33:14Z”“vcs_revision”“1D231626BA1D2838E599C5C598D28E2306AD4E48”“build_num”22.“结果”“失败的”},{“pushed_at”“2013-02-11t03:09:54z”“vcs_revision”“0553BA86B35A97E22AED78B0D568F6A7C79B838D”“build_num”21.“结果”“失败的”},......],“正在运行生成”[]//目前跑步建立}}},......]

得到请求。

返回您目前在Circleci上关注的所有项目数组,构建由分支组织的构建信息。

遵循Circleci的新项目

卷曲-X柱//www.drag240sx.com/api/v1.1/project/:vcs type/:username/:project/follow-H“循环令牌:
{“跟踪”真的“first_build”{“比较”空值“previous_successful_build”空值“build_parameters”空值“OSS”真的“committer_date”空值“身体”空值“使用情况\u排队时间\u”“2016-09-07T13:48:10.825z”“失败原因”空值“retry_of”空值“reponame”“测试 -  circleci”“ssh用户”[],“生成url”“//www.drag240sx.com/gh/circleci/mongofinil/1”“平行”1“失败的”空值“分支”“掌握”“用户名”“循环”“author_date”空值“为什么”“首次构建”“用户”{“is_user”真的“登录”“循环”“头像url”"https://avatars.githubusercontent.com/u/6017470?v=3英寸“姓名”“循环”“vcs_type”“github”“身份证”10101010},“vcs_revision”“B2B5DEF65BF54091DDE02EBB39EF3C54DE3FF049”“vcs\标签”空值“build_num”1“基础设施故障”错误的“committer_email”空值“以前的”空值“状态”“not_running”“committer_name”空值“重试”空值“主题”空值“vcs_type”“github”“时间到”错误的“不要构建”空值“生命周期”“not_running”“无依赖关系\u缓存”错误的“stop_time”空值“ssh\u已禁用”错误的“build_time_millis”空值“circle_yml”空值“消息”[],“是第一个绿色建筑吗”错误的“作业名称”空值“开始时间”空值“消除者”空值“结果”空值“vcs_url”“https://github.com/circleci/mongofinil”“作者姓名”空值“节点”空值“取消”错误的“author_email”空值}}

请求类型:邮政

跟踪一个新项目。CircleCI随后将监控项目自动构建提交。

最近在所有项目中建立

卷曲//www.drag240sx.com/api/v1.1/recent-builds?limit.=1&浅=真的
[{“vcs_url”“https://github.com/circleci/mongofinil”“生成url”“//www.drag240sx.com/gh/circleci/mongofinil/22”“build_num”22.“分支”“掌握”“vcs_revision”“1D231626BA1D2838E599C5C598D28E2306AD4E48”“committer_name”“艾伦罗纳”“committer_email”"arohner@gmail.com"“主题”“在系统时钟向后移动时不要爆炸”“身体”//犯罪信息身体“为什么”“github”//短的一串解释原因我们建造“不要构建”空值//原因为什么?我们没有建造如果我们没有建造“queued_at”“2013-02-12T21:33:30Z”//时间建造排队“开始时间”“2013-02-12T21:33:38z”//时间建造开始“stop_time”“2013-02-12T21:34:01Z”//时间建造完成“build_time_millis”23505.“用户名”“循环”“reponame”“蒙哥菲尔”“生命周期”“完成的”//排队预定不跑not_running.跑步或者完成“结果”“失败的”//取消基础架构_Fail.时间到失败no_tests.或者成功“状态”“失败的”//重试取消基础架构_Fail.时间到不跑跑步失败排队预定not_running.no_tests.固定的成功“retry_of”空值//构建数量建造一种重试“以前的”{//以前的建造“状态”“失败的”“build_num”21.},......]

请求类型:得到

返回最近30个构建的每个版本的构建摘要构建数量

范围 说明
限制 要返回的构建数量。最多100,默认为30。
抵消 API从此偏移开始返回构建,默认为0。
浅的 一个可选的布尔参数,如果设置为“true”,则可以发送该参数以提高性能。

笔记:在对项目信息进行API请求时,您可能会在服务器处理请求时遇到性能滞后和整体性能的减少。为了提高性能,Circleci建议您通过浅的请求中的参数。

最近为单个项目的构建

卷曲//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project?limit.=20和偏移=5&滤波器=完成-h.“循环令牌:

笔记:您可以通过在url后面附加/tree/:branch,将构建缩小到单个分支。注意,分支名称应该是url编码的。

例子:

卷曲//www.drag240sx.com/api/v1.1/recent-builds?limit.=1&浅=真的
[{“vcs_url”“https://github.com/circleci/mongofinil”“生成url”“//www.drag240sx.com/gh/circleci/mongofinil/22”“build_num”22.“分支”“掌握”“vcs_revision”“1D231626BA1D2838E599C5C598D28E2306AD4E48”“committer_name”“艾伦罗纳”“committer_email”"arohner@gmail.com"“主题”“在系统时钟向后移动时不要爆炸”“身体”//犯罪信息身体“为什么”“github”//短的一串解释原因我们建造“不要构建”空值//原因为什么?我们没有建造如果我们没有建造“queued_at”“2013-02-12T21:33:30Z”//时间建造排队“开始时间”“2013-02-12T21:33:38z”//时间建造开始跑步“stop_time”“2013-02-12T21:34:01Z”//时间建造完成跑步“build_time_millis”23505.“用户名”“循环”“reponame”“蒙哥菲尔”“生命周期”“完成的”//排队预定不跑not_running.跑步或者完成“结果”“失败的”//取消基础架构_Fail.时间到失败no_tests.或者成功“状态”“失败的”//重试取消基础架构_Fail.时间到不跑跑步失败排队预定not_running.no_tests.固定的成功“retry_of”空值//构建数量建造一种重试“以前的”{//以前的建造“状态”“失败的”“build_num”21.},......]

得到请求:返回由Build_Num订购的单个Git Repo中每个版本的每个构建的构建摘要。

范围 说明
限制 要返回的构建数量。最多100,默认为30。
抵消 API从此偏移开始返回构建,默认为0。
滤波器 限制返回的构建。设置为“完成”,“成功”,“失败”,“运行”,或默认为无过滤器。
浅的 如果设置为“true”,可选择可选的布尔值,以提高整体性能。

使用近期构建请求提高性能浅的范围

当对有关最近生成的信息发出API请求时,在服务器处理请求时,可能会遇到性能滞后和总体性能下降。为了提高性能,CircleCI建议您通过浅的请求中的参数。

右边的示例显示了用户对最近生成信息的请求。注意,当用户通过浅的参数,返回有限的信息集,从而提高了响应时间和最小化性能滞后。

使用该样本请求浅的范围

[{“committer_date”“2019-04-12T10:44:51-07:00”“身体”“使用情况\u排队时间\u”“2019-04-12T17:46:11.229Z”“reponame”“www.drag240sx.com”“生成url”"//www.drag240sx.com/gh/circleci/www.drag240sx.com/16315"“平行”1“分支”“ja-homepage”“用户名”“循环”“author_date”“2019-04-12T10:44:51-07:00”“为什么”“github”“用户”{“is_user”真的“登录”“特雷弗·西克莱奇”“头像url”“https://avatars1.githubusercontent.com/u/22457684?d=4”“姓名”空值“vcs_type”“github”“身份证”22457684},“vcs_revision”“8139060f4d1f6ff617ac49f8afb2273c4fee2343”“工作流”{“作业名称”“生成预览”“作业id”“981F2BFA-3C50-4505-865D-5266670217EB”“workflow_id”“A063AEAE-5B89-458B-8AA1-CCA4C565B07D”“工作区id”“A063AEAE-5B89-458B-8AA1-CCA4C565B07D”“上游_job_ids”[“7E92FBF5-8111-430B-8E2A-54B169BA745D”],“上游_concurrency_map”{},“工作流名称”“建立网站”},“vcs\标签”空值“pull_requests”[{“乌沙头”“8139060f4d1f6ff617ac49f8afb2273c4fee2343”“URL”"https://github.com/circleci/www.drag240sx.com/pull/2347"}],“build_num”16315“committer_email”“trevor@www.drag240sx.com”“状态”“成功”“committer_name”“Trevor Sorel”“主题”“添加日语的Main Vall”“不要构建”空值“生命周期”“完成的”“舰队”“皮卡德”“stop_time”“2019-04-12T17:47:42.298z”“build_time_millis”89366“开始时间”“2019-04-12T17:46:12.932z”“平台”“2.0”“结果”“成功”“vcs_url”“https://github.com/circleci/www.drag240sx.com”“作者姓名”“Trevor Sorel”“queued_at”“2019-04-12T17:46:11.289z”“author_email”“trevor@www.drag240sx.com”}]

清除项目缓存

删除请求:清除项目的缓存。

curl -x删除//www.drag240sx.com/api/v1.1/project/:vcs-type/:ususername/:project/build-cache -h“循环令牌:
{“状态”“构建缓存已删除”}

建立和工作

单个作业

卷曲//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/:build_num -h“循环令牌:
{“vcs_url”“https://github.com/circleci/mongofinil”“生成url”“//www.drag240sx.com/gh/circleci/mongofinil/22”“build_num”22.“分支”“掌握”“vcs_revision”“1D231626BA1D2838E599C5C598D28E2306AD4E48”“committer_name”“艾伦罗纳”“committer_email”"arohner@gmail.com"“主题”“在系统时钟向后移动时不要爆炸”“身体”//犯罪信息身体“为什么”“github”//短的一串解释原因建造“不要构建”空值//原因为什么?我们没有建造如果我们没有建造“queued_at”“2013-02-12T21:33:30Z”//时间建造排队“开始时间”“2013-02-12T21:33:38z”//时间建造开始“stop_time”“2013-02-12T21:34:01Z”//时间建造完成“build_time_millis”23505.“用户名”“循环”“reponame”“蒙哥菲尔”“生命周期”“完成的”//排队预定不跑not_running.跑步或者完成“结果”“成功”//取消基础架构_Fail.时间到失败no_tests.或者成功“状态”“成功”//重试取消基础架构_Fail.时间到不跑跑步失败排队预定not_running.no_tests.固定的成功“retry_of”空值//构建数量建造一种重试“脚步”[{“姓名”“配置生成”“行动”[{“bash\u命令”空值“运行时间\u毫秒”1646“开始时间”“2013-02-12T21:33:38z”“时间结束”“2013-02-12T21:33:39Z”“姓名”“配置生成”“EXIT_CODE”空值“类型”“基础设施”“索引”0.“状态”“成功”}]},“姓名”“Lein2 deps”“行动”[{“bash\u命令”“Lein2 deps”“运行时间\u毫秒”7555“开始时间”“2013-02-12T21:33:47z”“消息”[],“步骤”1“EXIT_CODE”0.“时间结束”“2013-02-12T21:33:54Z”“索引”0.“状态”“成功”“类型”“依赖性”“来源”“推理”“失败的”空值}]},“姓名”“Lein2蹦床Midje”“行动”[{“bash\u命令”“Lein2蹦床Midje”“运行时间\u毫秒”2310.“继续”空值“平行”真的“开始时间”“2013-02-12T21:33:59Z”“姓名”“Lein2蹦床Midje”“消息”[],“步骤”6.“EXIT_CODE”1“时间结束”“2013-02-12T21:34:01Z”“索引”0.“状态”“失败的”“时间到”空值“基础设施故障”空值“类型”“测试”“来源”“推理”“失败的”真的}]}],......}

得到请求:返回单个作业的完整详细信息。响应包括作业摘要中的所有字段。

重试构建

curl -x post //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/retry -h“循环令牌:

您可以通过将“retry”替换为“ssh”来使用ssh重试构建。

{“vcs_url”“https://github.com/circleci/mongofinil”“生成url”“//www.drag240sx.com/gh/circleci/mongofinil/23”“build_num”23.“分支”“掌握”“vcs_revision”“1D231626BA1D2838E599C5C598D28E2306AD4E48”“committer_name”“艾伦罗纳”“committer_email”"arohner@gmail.com"“主题”“在系统时钟向后移动时不要爆炸”“身体”//犯罪信息身体“为什么”“重试”//短的一串解释原因我们建造“不要构建”空值//原因为什么?我们没有建造如果我们没有建造“queued_at”“2013-04-12T21:33:30z”//时间建造排队“开始时间”“2013-04-12T21:33:38z”//时间建造开始跑步“stop_time”“2013-04-12T21:34:01Z”//时间建造完成跑步“build_time_millis”23505.“用户名”“循环”“reponame”“蒙哥菲尔”“生命周期”“排队”“结果”空值“状态”“排队”“retry_of”22.//构建数量建造一种重试“以前的”{//以前的建造“状态”“失败的”“build_num”22.}}

邮政请求:重试生成,然后返回新生成的摘要。

将用户添加到构建

curl -x post //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/ssh-users -h“循环令牌:
#...构建数据

邮政请求:此API呼叫仅在使用用户API令牌时可用。如果当前用户有权构建项目,则该API将当前用户的SSH公钥添加到运行构建的每个容器上的授权密钥。这允许它们SSH到构建容器。

取消构建

curl -x post //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/cancel -h“循环令牌:
{“vcs_url”“https://github.com/circleci/mongofinil”“生成url”"//www.drag240sx.com/gh/circleci/mongofinil/26"“build_num”26.“分支”“掌握”“vcs_revision”“59C9C5EA3E289F2F3B0C94E128267CC0CE2D65C6”“committer_name”“艾伦罗纳”“committer_email”"arohner@gmail.com"“主题”“从Dlowe / Master合并拉请求#6”“身体”“le bump”//犯罪信息身体“为什么”“重试”//短的一串解释原因我们建造“不要构建”空值//原因为什么?我们没有建造如果我们没有建造“queued_at”“2013-05-24T19:37:59.095Z”//时间建造排队“开始时间”空值//时间建造开始跑步“stop_time”空值//时间建造完成跑步“build_time_millis”空值“用户名”“循环”“reponame”“蒙哥菲尔”“生命周期”“排队”“结果”“取消”“状态”“取消”“取消”真的“retry_of”25.//构建数量建造一种重试“以前的”{//以前的建造“状态”“成功”“build_num”25.}}

邮政请求:取消生成,然后返回生成的摘要。

触发新任务

Curl -X帖子 - 主人“内容类型:应用程序/ JSON”-H“循环令牌:-D.'{“标记”:“v0.1”,//可选的“并行”:2,//可选,默认为null“build_parameters”:{//可选的“run_extra_tests”:“true”}}“//www.drag240sx.com/api/v1.1/project/:vcs类型/:用户名/:项目
{“作者姓名”“艾伦罗纳”“生成url”“//www.drag240sx.com/gh/circleci/mongofinil/54”“reponame”“蒙哥菲尔”“失败的”空值“基础设施故障”错误的“取消”错误的“所有提交详细信息”[{“作者姓名”“艾伦罗纳”“提交”“F1BAEB913288519DD9A942499CEF2873F5B1C2BF”“author_login”“阿罗纳”“提交者登录”“阿罗纳”“committer_name”“艾伦罗纳”“身体”“次要版本碰撞”“author_date”“2014-04-17T08:41:40z”“committer_date”“2014-04-17T08:41:40z”“commit_url”“https://github.com/circleci/mongofinil/commit/f1baeb913288519dd9a942499cef2873f5b1c2bf”“committer_email”"arohner@gmail.com"“author_email”"arohner@gmail.com"“主题”“来自circleci/minor version bump的合并请求#15”}],“以前的”{“build_num”53“状态”“成功”“build_time_millis”55413.},“ssh_enabled”空值“author_email”"arohner@gmail.com"“为什么”“编辑”“build_time_millis”空值“committer_email”"arohner@gmail.com"“平行”2“重试”空值“比较”空值“不要构建”空值“committer_name”“艾伦罗纳”“使用情况\u排队时间\u”“2014-04-29T12:56:55.338Z”“分支”“掌握”“身体”“次要版本碰撞”“author_date”“2014-04-17T08:41:40z”“节点”空值“committer_date”“2014-04-17T08:41:40z”“开始时间”空值“stop_time”空值“生命周期”“not_running”“用户”{“电子邮件”"arohner@gmail.com"“姓名”“艾伦罗纳”“登录”“阿罗纳”“is_user”真的},“主题”“来自circleci/minor version bump的合并请求#15”“消息”[],“作业名称”空值“retry_of”空值“previous_successful_build”{“build_num”53“状态”“成功”“build_time_millis”55413.},“结果”空值“状态”“not_running”“vcs_revision”“F1BAEB913288519DD9A942499CEF2873F5B1C2BF”“vcs\标签”“第0.1版”“build_num”54“用户名”“循环”“vcs_url”“https://github.com/circleci/mongofinil”“时间到”错误的}

也可以看看

用API触发作业

邮政请求:触发新构建,然后返回构建的摘要。

范围 说明
修订 建立的具体修订。默认为null,使用分支的head。不能与标记参数一起使用。
标签 要生成的标记。默认值为空。不能与修订参数一起使用。
平行 用于运行构建的容器的数量。默认为null,使用项目默认值。在2.0基础架构上运行的构建,忽略此参数。
生成\u参数 其他环境变量注入构建环境。值的名称地图。

笔记目前不支持触发新作业,指定的配置版本:2.1

用分支触发一份新作业

Curl -X帖子 - 主人“内容类型:应用程序/ JSON”-H“循环令牌:-D.“{”parallel“:2,//可选,默认为null“revision”:“f1baeb913288519dd9a942499cef2873f5b1c2bf”//optional“build\u parameters”:{//optional“RUN\u EXTRA\u TESTS”:“true”}//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/tree/: branch.
{“作者姓名”“艾伦罗纳”“生成url”“//www.drag240sx.com/gh/circleci/mongofinil/54”“reponame”“蒙哥菲尔”“失败的”空值“基础设施故障”错误的“取消”错误的“所有提交详细信息”[{“作者姓名”“艾伦罗纳”“提交”“F1BAEB913288519DD9A942499CEF2873F5B1C2BF”“author_login”“阿罗纳”“提交者登录”“阿罗纳”“committer_name”“艾伦罗纳”“身体”“次要版本碰撞”“author_date”“2014-04-17T08:41:40z”“committer_date”“2014-04-17T08:41:40z”“commit_url”“https://github.com/circleci/mongofinil/commit/f1baeb913288519dd9a942499cef2873f5b1c2bf”“committer_email”"arohner@gmail.com"“author_email”"arohner@gmail.com"“主题”“来自circleci/minor version bump的合并请求#15”}],“以前的”{“build_num”53“状态”“成功”“build_time_millis”55413.},“ssh_enabled”空值“author_email”"arohner@gmail.com"“为什么”“编辑”“build_time_millis”空值“committer_email”"arohner@gmail.com"“平行”2“重试”空值“比较”空值“不要构建”空值“committer_name”“艾伦罗纳”“使用情况\u排队时间\u”“2014-04-29T12:56:55.338Z”“分支”“掌握”“身体”“次要版本碰撞”“author_date”“2014-04-17T08:41:40z”“节点”空值“committer_date”“2014-04-17T08:41:40z”“开始时间”空值“stop_time”空值“生命周期”“not_running”//排队预定不跑not_running.跑步或者完成“用户”{“电子邮件”"arohner@gmail.com"“姓名”“艾伦罗纳”“登录”“阿罗纳”“is_user”真的},“主题”“来自circleci/minor version bump的合并请求#15”“消息”[],“作业名称”空值“retry_of”空值“previous_successful_build”{“build_num”53“状态”“成功”“build_time_millis”55413.},“结果”空值“状态”“not_running”“vcs_revision”“F1BAEB913288519DD9A942499CEF2873F5B1C2BF”“build_num”54“用户名”“循环”“vcs_url”“https://github.com/circleci/mongofinil”“时间到”错误的}

邮政请求:触发新构建,然后返回构建的摘要。

范围 说明
修订 建立的具体修订。默认为null,使用分支的head。不能与标记参数一起使用。
平行 用于运行构建的容器的数量。默认为null,使用项目默认值。在2.0基础架构上运行的构建,忽略此参数。
生成\u参数 其他环境变量注入构建环境。值的名称地图。

笔记使用分支触发新作业当前不受指定版本:2.1

按项目触发新生成(预览)

curl -x post //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/build -h“循环令牌:
{“状态”200.“身体”“建立创造”}

邮政请求:触发指定项目的构建,按分支,修订版或标记。工作流程将以与从源控制的Webhook接收到相同的方式运行或计划。

范围 说明
修订 要构建的特定修订。如果未指定,则使用分支的头。不能与标记参数一起使用
分支 要建立的分支。不能与标记参数一起使用。
标签 git标记要构建。不能与分支和修订参数一起使用。

获取构建测试元数据

卷曲//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/tests -h“循环令牌:
{“测试”[{“信息”“文件”“功能/桌面/邀请.功能"“来源”“黄瓜”“运行时间”2.957513661“结果”“成功”“姓名”“接受邀请”“类名”“邀请”},{“信息”空值“文件”“规范/lib/webfinger”_规范rb"“来源”“rspec”“运行时间”0.011366“结果”“成功”“姓名”“webfinger#intialize sets帐户”“类名”“spec.lib.webfinger_spec”}]}

得到请求为生成提供测试元数据。

钥匙

列出结帐密钥

卷曲//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/checkout -key -h.“循环令牌:
[{“public_key”“ssh-rsa ......”“类型”“部署密钥”//可以“部署密钥”或者“github-user-key”“指纹”“c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f”“首选”真的“时间”“2015-09-21T17:29:21.042Z”//什么时候钥匙发布}]

得到请求:返回的签出键数组:项目。

新的结账钥匙

Curl -X帖子 - 主人“内容类型:应用程序/ JSON”-D.'{“类型”:“github-user-key”}“//www.drag240sx.com/api/v1.1/project/:vcs type/:username/:project/checkout键-H“循环令牌:
{“public_key”“ssh-rsa ......”“类型”“部署密钥”//可以“部署密钥”或者“用户密钥”“指纹”“c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f”“首选”真的“时间”“2015-09-21T17:29:21.042Z”//什么时候钥匙发布}

邮政请求:创建一个新的结账键。此API请求仅适用于用户API令牌。

范围 说明
类型 要创建的键的类型。可以是“deploy key”或“github user key”。

获取结账钥匙

curl //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/checkout -key/:fingerprint -h.“循环令牌:
{“public_key”“ssh-rsa ......”“类型”“部署密钥”//可以“部署密钥”或者“用户密钥”“指纹”“c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f”“首选”真的“时间”“2015-09-21T17:29:21.042Z”//什么时候钥匙发布}

得到请求:返回单个签出键。

删除结帐键

删除请求:删除签出键。

卷曲-X删除//www.drag240sx.com/api/v1.1/project/:vcs type/:username/:project/checkout key/:fingerprint-H“循环令牌:
{“信息”“好的”}

创建SSH键

邮政请求:创建一个SSH密钥,该密钥将用于访问由主机名参数标识的外部系统,以获取基于SSH基于密钥的身份验证。

Curl -X帖子 - 主人“内容类型:应用程序/ JSON”-D.'{“hostname”:“hostname”,“private_key”:“RSA私钥”}“//www.drag240sx.com/api/v1.1/project/:vcs type/:username/:project/ssh key-H“循环令牌:
#预期没有回复

删除SSH键

curl-X DELETE—标题“内容类型:应用程序/ JSON”-D.{“指纹”“指纹”“主机名”“主机名”}//www.drag240sx.com/api/v1.1/project/:vcs type/:username/:project/ssh key-H“循环令牌:
#预期没有回复

删除请求:从系统中删除SSH密钥。

Heroku钥匙

邮政请求:将您的Heroku API键添加到Circleci,然后采取apikey.表格参数名称。

Curl -X帖子 - 主人“内容类型:应用程序/ JSON”-D.“{”apikey“:”Heroku key“}”//www.drag240sx.com/user/heroku -key -h.“循环令牌:
#预期没有回复

伪影

构建的工件

卷曲//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/artifacts -h“循环令牌:
[{“小路”“原始测试输出/ go-test-report.xml”“pretty_path”“原始测试输出/ go-test-report.xml”“node_index”0.“URL”"https://24-88881093-gh.circle-artifacts.com/0/raw-test-output/go-test-report.xml"},{“小路”“原始测试输出/ go-test.out”“pretty_path”“原始测试输出/ go-test.out”“node_index”0.“URL”"https://24-88881093-gh.circle-artifacts.com/0/raw-test-output/go-test.out"}]

返回由给定版本生成的artifact数组。请求类型:得到

笔记

下载工件文件

您可以通过带有API令牌认证HTTP请求的API下载单个工件文件。

curl -l https://132-55688803-gh.circle-artifacts.com/0//tmp/circle-artifacts.7wgaaiu/file.txt-h“循环令牌:

笔记

最新版本的工件

curl //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/latest/artifacts?branch.=:分支机滤波器=:过滤器-H.“循环令牌:
[{“小路”“原始测试输出/ go-test-report.xml”“pretty_path”“原始测试输出/ go-test-report.xml”“node_index”0.“URL”"https://24-88881093-gh.circle-artifacts.com/0/raw-test-output/go-test-report.xml"},{“小路”“原始测试输出/ go-test.out”“pretty_path”“原始测试输出/ go-test.out”“node_index”0.“URL”"https://24-88881093-gh.circle-artifacts.com/0/raw-test-output/go-test.out"}]

返回由给定分支上的最新版本生成的artifact数组。

请求类型:得到

范围 说明
分支 您希望查看最新版本的分支。如果省略,返回整个项目中最新版本的工件。
滤波器 限制返回的构建。设置为“完成”,“成功”,“失败”,“运行”,或默认为无过滤器。

笔记

环境变量

列出环境变量

卷曲//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/envvar -h“循环令牌:
[{“姓名”“foo”“价值”“XX1234”}]

得到请求:返回四个'x'字符加上值的最后四个ASCII字符,与Circleci网站中的环境变量值的显示一致。

添加环境变量

Curl -X帖子 - 主人“内容类型:应用程序/ JSON”-D.'{“name”:“foo”,“value”:“bar”}'//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/envvar -h“循环令牌:
{“姓名”“foo”“价值”“xxxx号”}

邮政请求创建一个新的环境变量。

获取单个环境变量

卷曲//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/envvar/:name -h“循环令牌:
{“姓名”“foo”“价值”“xxxx号”}

得到请求:返回环境变量的隐藏值:名称

删除环境变量

curl -x删除//www.drag240sx.com/api/v1.1/project/:vcs-type/:ususername/:project/envvar/:name -h“循环令牌:
{“信息”“好的”}

删除请求删除名为:name的环境变量。