纳税Navbar

Circleci V1 API概述

The CircleCI API is a full-featured RESTful API that allows you to access all information and trigger all actions in CircleCI. RESTful APIs enable you to call individual API endpoints to perform the following actions:

Rate Limiting

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

由于API与Circleci集成的作者,您的集成应该期望令人盗贼,并且应该能够优雅地处理失败。API的不同部位有不同的保护和限制。特别是,我们保护我们的API反对sudden large bursts of traffic,我们保护持续高卷的requests, for example, frequent polling.

For HTTP APIs, when a request is throttled, you will receiveHTTP状态代码429。If your integration requires that a throttled request is completed, then you should retry these requests after a delay, using an exponential backoff. In most cases, the HTTP 429 response code will be accompanied by theRetry-After HTTP header。When this header is present, your integration should wait for the period of time specified by the header value before retrying a request.

API语法

When making an API request, make sure you follow standard REST API syntax and formatting. Adhering to proper REST API syntax ensures that the API server can properly process your request and return a JSON response. To make a request to the CircleCI API, use the format shown in the pane to the right:

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

Where:

身份验证

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

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

添加API令牌

$curl -H"Circle-Token: "//www.drag240sx.com/api/v1.1//me
{“用户密钥\u指纹”空值“days_left_in_trial”-238"plan"“p16”“trial_end”"2011-12-28T22:02:15Z"“basic_email_prefs”"smart"“行政”真的“登录”“pbiggar”}

To add an API token, perform the steps listed below.

  1. Add an API token from your帐户仪表板
  2. 测试它,View it in your browser或使用api使用
  3. 您应该会看到类似于右窗格中所示示例的响应。

获得身份验证

curl -H"Circle-Token: ""//www.drag240sx.com/api/..."
卷曲-u"//www.drag240sx.com/api/..."
curl"//www.drag240sx.com/api/v1.1/me?circle-token="

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

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

Or you can use the API token as the username for HTTP Basic Authentication, by passing the-u旗帜到curlcommand:

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

Version Control Systems (:vcs-type)

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

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

F/OSS

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

列表排序

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

列表订单有两个API端点:

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

接受Header

curl //www.drag240sx.com/api/v1.1/me -H“接受:application / json”-H"Circle-Token: "

如果未指定接受标题(或者它为空),则Circleci将以Clojure EDN格式返回数据。要接收与格式化的JSON的数据,包括任何值接受header (e.gtext/plain). If you prefer to receive compact JSON with no whitespace or comments, use一种pplication/json作为接受标题。

入门

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

Summary of API Endpoints

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

获取请求

API Description
/me 提供有关用户签名的信息。
/项目 Lists all projects you are following on CircleCI, with build information organized by branch.
/项目/:vcs-type /:用户名/:项目 为单个Git Repo中每个版本的每个构建返回构建摘要。
/recent-builds 返回最近30个构建的每个版本的构建摘要建造_num.
/项目/:vcs-type /:用户名/:项目/:build_num 返回单个构建的完整详细信息。该响应包括来自构建摘要的所有字段。这也是有效载荷通知webhooks那在which case this object is the value to a key named ‘payload’.
/项目/:vcs类型/:用户名/:项目/:生成数量/工件 列出由给定构建生成的工件。
/项目/:vcs-type /:用户名/:project / checkout-key/:fingerprint 检索结账键。

发布请求

API Description
/项目/:vcs-type /:用户名/:项目/follow 关注CircleCI的一个新项目。
/project/:vcs type/:username/:project/:build\u num/重试 重试构建,返回新版本的摘要。
/项目/:vcs-type /:用户名/:项目/:build_num/cancel Cancels the build, returns a summary of the build.
/项目/:vcs-type /:用户名/:project /:build_num / ssh-users 将用户添加到Build的SSH权限。
/项目/:vcs-type /:用户名/:project /树/:分支 触发新生成,返回生成的摘要。可选1.0构建参数可以是set as well and Optional 2.0构建参数
/项目/:vcs类型/:用户名/:项目/ssh密钥 创建用于访问需要SSH基于键的身份验证的外部系统的SSH密钥。
/项目/:vcs-type /:用户名/:project / checkout-key 创建一个新的结账键。

DELETE Requests

API Description
/项目/:vcs-type /:用户名/:project / checkout-key/:fingerprint Deletes a checkout key.
/项目/:vcs类型/:用户名/:项目/ssh密钥 从项目中删除SSH密钥。

用户

curl //www.drag240sx.com/api/v1.1/me -H"Circle-Token: "
{“basic_email_prefs”"smart"//可以"smart"“没有任何”or“全部”“登录”“pbiggar”//你的github用户名}

GETRequest:提供有关当前登录的用户的信息。

项目

If you would like to retrieve detailed information about projects, CircleCI provides several different endpoints that you may call to return this information, including the ability to return detailed information for all projects. To ensure you do not encounter any performance-related lags or issues when making an API request, you may wish to limit your search for a single project instead of an array of projects.

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

Get All Followed Projects

卷曲//www.drag240sx.com/api/v1.1/projects -小时"Circle-Token: "
[{"vcs_url"“https://github.com/circleci/mongofinil”"followed"真的//真的如果跟随thisproject圆环"username""circleci"“reponame”“蒙哥菲尔”“分支机构”{“掌握”{“pusher_logins”[“pbiggar”“阿罗纳”]那//用户“last_non_success”{//last失败建造onthis分支“pushed_at”“2013-02-12T21:33:14Z”“vcs_revision”“1D231626BA1D2838E599C5C598D28E2306AD4E48”“build_num”22“结果”"failed"}那"last_success"{//last成功ful建造onthis分支“pushed_at”“2012-08-09T03:59:53z”“vcs_revision”“384211BBE72B2A22997116A78788117B3922D570”“build_num”15.“结果”“成功”}那“最近_Builds”[{//last5.建造s订购经过推_at(减少)“pushed_at”“2013-02-12T21:33:14Z”“vcs_revision”“1D231626BA1D2838E599C5C598D28E2306AD4E48”“build_num”22“结果”"failed"}那{“pushed_at”“2013-02-11t03:09:54z”“vcs_revision”“0553BA86B35A97E22AED78B0D568F6A7C79B838D”“build_num”21“结果”"failed"}那。。。]那"running_builds"[]//目前跑步建造s}}}那。。。]

GET请求。

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

Follow a New Project on CircleCI

curl -X POST //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/follow -H"Circle-Token: "
{"followed"真的“first_build”{“比较”空值“previous_successful_build”空值“build_parameters”空值“OSS”真的“committ_date”空值“身体”空值"usage_queued_at""2016-09-07T13:48:10.825Z"“失败原因”空值“retry_of”空值“reponame”“测试 -  circleci”“ssh用户”[]那"build_url""//www.drag240sx.com/gh/circleci/mongofinil/1""parallel"1"failed"空值“分支”“掌握”"username""circleci""author_date"空值"why"“首次构建”"user"{“is_user”真的“登录”"circleci""avatar_url""https://avatars.githubusercontent.com/u/6017470?v=3"“名称”"CircleCI"“vcs_type”“github”"id"10.10.10.10.}那“vcs_revision”"b2b5def65bf54091dde02ebb39ef3c54de3ff049""vcs_tag"空值“build_num”1“基础设施故障”错误的“committer_email”空值"previous"空值"status"“not_running”“committer_name”空值"retries"空值"subject"空值“vcs_type”“github”“时间到”错误的"dont_build"空值“生命周期”“not_running”“无依赖关系\u缓存”错误的“stop_time”空值"ssh_disabled"错误的“build_time_millis”空值"circle_yml"空值“消息”[]那“是第一个绿色建筑吗”错误的"job_name"空值“开始时间”空值“消除者”空值“结果”空值"vcs_url"“https://github.com/circleci/mongofinil”"author_name"空值"node"空值"canceled"错误的“author_email”空值}}

请求类型:邮政

Follows a new project. CircleCI will then monitor the project for automatic building of commits.

最近在所有项目中建立

卷曲//www.drag240sx.com/api/v1.1/recent-builds?limit.=1&浅=真的
[{"vcs_url"“https://github.com/circleci/mongofinil”"build_url""//www.drag240sx.com/gh/circleci/mongofinil/22"“build_num”22“分支”“掌握”“vcs_revision”“1D231626BA1D2838E599C5C598D28E2306AD4E48”“committer_name”“艾伦罗纳”“committer_email”"arohner@gmail.com""subject"“在系统时钟向后移动时不要爆炸”“身体”//commit信息身体"why"“github”//shortstring解释reasonwe建造"dont_build"空值//reason为什么?we没有建造如果we没有建造"queued_at""2013-02-12T21:33:30Z"//time建造wasqueued“开始时间”“2013-02-12T21:33:38z”//time建造started“stop_time”“2013-02-12T21:34:01Z”//time建造完成“build_time_millis”23505."username""circleci"“reponame”“蒙哥菲尔”“生命周期”“完成的”//queuedschedulednot_runnot_running跑步or完成“结果”"failed"//取消基础架构_Fail.时间到失败no_tests.or成功"status""failed"//重试取消基础架构_Fail.时间到not_run跑步失败queuedschedulednot_runningno_tests.fixed成功“retry_of”空值//建造_num建造this一种重试"previous"{//previous建造"status""failed"“build_num”21}那。。。]

请求类型:GET

返回最近30个构建的每个版本的构建摘要建造_num

范围 Description
限制 The number of builds to return. Maximum 100, defaults to 30.
抵消 The API returns builds starting from this offset, defaults to 0.
一个可选的布尔参数,如果设置为“true”,则可以发送该参数以提高性能。

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

最近为单个项目的构建

卷曲//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project?limit.=20和偏移=5.&filter=完成-h."Circle-Token: "

笔记:You can narrow the builds to a single branch by appending /tree/:branch to the url. Note that the branch name should be url-encoded.

Example:

卷曲//www.drag240sx.com/api/v1.1/recent-builds?limit.=1&浅=真的
[{"vcs_url"“https://github.com/circleci/mongofinil”"build_url""//www.drag240sx.com/gh/circleci/mongofinil/22"“build_num”22“分支”“掌握”“vcs_revision”“1D231626BA1D2838E599C5C598D28E2306AD4E48”“committer_name”“艾伦罗纳”“committer_email”"arohner@gmail.com""subject"“在系统时钟向后移动时不要爆炸”“身体”//commit信息身体"why"“github”//shortstring解释reasonwe建造"dont_build"空值//reason为什么?we没有建造如果we没有建造"queued_at""2013-02-12T21:33:30Z"//time建造wasqueued“开始时间”“2013-02-12T21:33:38z”//time建造started跑步“stop_time”“2013-02-12T21:34:01Z”//time建造完成跑步“build_time_millis”23505."username""circleci"“reponame”“蒙哥菲尔”“生命周期”“完成的”//queuedschedulednot_runnot_running跑步or完成“结果”"failed"//取消基础架构_Fail.时间到失败no_tests.or成功"status""failed"//重试取消基础架构_Fail.时间到not_run跑步失败queuedschedulednot_runningno_tests.fixed成功“retry_of”空值//建造_num建造this一种重试"previous"{//previous建造"status""failed"“build_num”21}那。。。]

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

范围 Description
限制 The number of builds to return. Maximum 100, defaults to 30.
抵消 The API returns builds starting from this offset, defaults to 0.
filter 限制返回的构建。设置为“完成”,“成功”,“失败”,“运行”,或默认为无过滤器。
如果设置为“true”,可选择可选的布尔值,以提高整体性能。

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

When making API requests for information about recent builds, you may experience performance lag and a decrease in overall performance while the request is being processed by the server. To improve performance, CircleCI recommends you pass the请求中的参数。

向右的例子展示了一个用户请求recent build information. Notice that when the user passes the参数,返回有限的信息集,从而提高了响应时间和最小化性能滞后。

Sample Request Using the范围

[{“committ_date”"2019-04-12T10:44:51-07:00"“身体”"usage_queued_at""2019-04-12T17:46:11.229Z"“reponame”"www.drag240sx.com""build_url""//www.drag240sx.com/gh/circleci/www.drag240sx.com/16315""parallel"1“分支”“ja-homepage”"username""circleci""author_date""2019-04-12T10:44:51-07:00""why"“github”"user"{“is_user”真的“登录”"trevor-circleci""avatar_url"“https://avatars1.githubusercontent.com/u/22457684?d=4”“名称”空值“vcs_type”“github”"id"22457684}那“vcs_revision”"8139060f4d1f6ff617ac49f8afb2273c4fee2343""workflows"{"job_name""build-preview""job_id""981f2bfa-3c50-4505-865d-5266670217eb"“workflow_id”"a063aeae-5b89-458b-8aa1-cca4c565b07d""workspace_id""a063aeae-5b89-458b-8aa1-cca4c565b07d"“上游_job_ids”[“7E92FBF5-8111-430B-8E2A-54B169BA745D”]那"upstream_concurrency_map"{},“工作流名称”"build-website"}那"vcs_tag"空值"pull_requests"[{"head_sha""8139060f4d1f6ff617ac49f8afb2273c4fee2343"“URL”"https://github.com/circleci/www.drag240sx.com/pull/2347"}],“build_num”16315“committer_email”"trevor@www.drag240sx.com""status"“成功”“committer_name”“Trevor Sorel”"subject"“添加日语的Main Vall”"dont_build"空值“生命周期”“完成的”"fleet""picard"“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""author_name"“Trevor Sorel”"queued_at"“2019-04-12T17:46:11.289z”“author_email”"trevor@www.drag240sx.com"}]

建立和工作

Single Job

curl //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/:build_num -H"Circle-Token: "
{"vcs_url"“https://github.com/circleci/mongofinil”"build_url""//www.drag240sx.com/gh/circleci/mongofinil/22"“build_num”22“分支”“掌握”“vcs_revision”“1D231626BA1D2838E599C5C598D28E2306AD4E48”“committer_name”“艾伦罗纳”“committer_email”"arohner@gmail.com""subject"“在系统时钟向后移动时不要爆炸”“身体”//commit信息身体"why"“github”//shortstring解释reason建造"dont_build"空值//reason为什么?we没有建造如果we没有建造"queued_at""2013-02-12T21:33:30Z"//time建造wasqueued“开始时间”“2013-02-12T21:33:38z”//time建造started“stop_time”“2013-02-12T21:34:01Z”//time建造完成“build_time_millis”23505."username""circleci"“reponame”“蒙哥菲尔”“生命周期”“完成的”//queuedschedulednot_runnot_running跑步or完成“结果”“成功”//取消基础架构_Fail.时间到失败no_tests.or成功"status"“成功”//重试取消基础架构_Fail.时间到not_run跑步失败queuedschedulednot_runningno_tests.fixed成功“retry_of”空值//建造_num建造this一种重试“脚步”[{“名称”“配置生成”"actions"[{“bash\u命令”空值“运行时间\u毫秒”16.46“开始时间”“2013-02-12T21:33:38z”"end_time"“2013-02-12T21:33:39Z”“名称”“配置生成”“EXIT_CODE”空值"type""infrastructure"“索引”0."status"“成功”}]}那“名称”"lein2 deps""actions"[{“bash\u命令”"lein2 deps"“运行时间\u毫秒”7555“开始时间”"2013-02-12T21:33:47Z"“消息”[]那“步骤”1“EXIT_CODE”0."end_time""2013-02-12T21:33:54Z"“索引”0."status"“成功”"type"“依赖性”"source"“推理”"failed"空值}]}那“名称”“Lein2蹦床Midje”"actions"[{“bash\u命令”“Lein2蹦床Midje”“运行时间\u毫秒”2310.“继续”空值"parallel"真的“开始时间”“2013-02-12T21:33:59Z”“名称”“Lein2蹦床Midje”“消息”[]那“步骤”6.“EXIT_CODE”1"end_time"“2013-02-12T21:34:01Z”“索引”0."status""failed"“时间到”空值“基础设施故障”空值"type""test""source"“推理”"failed"真的}]}]那。。。}

GET请求:Returns the full details for a single job. The response includes all of the fields from the job summary.

重试构建

curl -X POST //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/retry -H"Circle-Token: "

You can retry a build with ssh by swapping “retry” with “ssh”.

{"vcs_url"“https://github.com/circleci/mongofinil”"build_url""//www.drag240sx.com/gh/circleci/mongofinil/23"“build_num”23“分支”“掌握”“vcs_revision”“1D231626BA1D2838E599C5C598D28E2306AD4E48”“committer_name”“艾伦罗纳”“committer_email”"arohner@gmail.com""subject"“在系统时钟向后移动时不要爆炸”“身体”//commit信息身体"why"“重试”//shortstring解释reasonwe建造"dont_build"空值//reason为什么?we没有建造如果we没有建造"queued_at"“2013-04-12T21:33:30z”//time建造wasqueued“开始时间”"2013-04-12T21:33:38Z"//time建造started跑步“stop_time”"2013-04-12T21:34:01Z"//time建造完成跑步“build_time_millis”23505."username""circleci"“reponame”“蒙哥菲尔”“生命周期”“排队”“结果”空值"status"“排队”“retry_of”22//建造_num建造this一种重试"previous"{//previous建造"status""failed"“build_num”22}}

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

将用户添加到构建

curl -x post //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/ssh-users -h"Circle-Token: "
#...构建数据

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

取消构建

curl -x post //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/cancel -h"Circle-Token: "
{"vcs_url"“https://github.com/circleci/mongofinil”"build_url""//www.drag240sx.com/gh/circleci/mongofinil/26"“build_num”26.“分支”“掌握”“vcs_revision”“59C9C5EA3E289F2F3B0C94E128267CC0CE2D65C6”“committer_name”“艾伦罗纳”“committer_email”"arohner@gmail.com""subject"“从Dlowe / Master合并拉请求#6”“身体”“le bump”//commit信息身体"why"“重试”//shortstring解释reasonwe建造"dont_build"空值//reason为什么?we没有建造如果we没有建造"queued_at"“2013-05-24T19:37:59.095Z”//time建造wasqueued“开始时间”空值//time建造started跑步“stop_time”空值//time建造完成跑步“build_time_millis”空值"username""circleci"“reponame”“蒙哥菲尔”“生命周期”“排队”“结果”"canceled""status""canceled""canceled"真的“retry_of”25.//建造_num建造this一种重试"previous"{//previous建造"status"“成功”“build_num”25.}}

邮政请求:Cancels the build and then returns a summary of the build.

Trigger a new Job

curl -X POST --header“内容类型:应用程序/ JSON”-H"Circle-Token: "-D.'{“标记”:“v0.1”,//可选的“并行”:2,//可选,默认为null“build_parameters”:{//可选的“run_extra_tests”:“true”}}“//www.drag240sx.com/api/v1.1/project/:vcs类型/:用户名/:项目
{"author_name"“艾伦罗纳”"build_url""//www.drag240sx.com/gh/circleci/mongofinil/54"“reponame”“蒙哥菲尔”"failed"空值“基础设施故障”错误的"canceled"错误的“所有提交详细信息”[{"author_name"“艾伦罗纳”“提交”“F1BAEB913288519DD9A942499CEF2873F5B1C2BF”"author_login"“阿罗纳”"committer_login"“阿罗纳”“committer_name”“艾伦罗纳”“身体”“次要版本碰撞”"author_date"“2014-04-17T08:41:40z”“committ_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""subject"“来自circleci/minor version bump的合并请求#15”}],"previous"{“build_num”5.3"status"“成功”“build_time_millis”55413.}那“ssh_enabled”空值“author_email”"arohner@gmail.com""why"“编辑”“build_time_millis”空值“committer_email”"arohner@gmail.com""parallel"2"retries"空值“比较”空值"dont_build"空值“committer_name”“艾伦罗纳”"usage_queued_at"“2014-04-29T12:56:55.338Z”“分支”“掌握”“身体”“次要版本碰撞”"author_date"“2014-04-17T08:41:40z”"node"空值“committ_date”“2014-04-17T08:41:40z”“开始时间”空值“stop_time”空值“生命周期”“not_running”"user"{“电子邮件”"arohner@gmail.com"“名称”“艾伦罗纳”“登录”“阿罗纳”“is_user”真的}那"subject"“来自circleci/minor version bump的合并请求#15”“消息”[],"job_name"空值“retry_of”空值“previous_successful_build”{“build_num”5.3"status"“成功”“build_time_millis”55413.}那“结果”空值"status"“not_running”“vcs_revision”“F1BAEB913288519DD9A942499CEF2873F5B1C2BF”"vcs_tag"“第0.1版”“build_num”5.4"username""circleci""vcs_url"“https://github.com/circleci/mongofinil”“时间到”错误的}

也可以看看

用API触发作业

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

范围 Description
修订 建立的具体修订。默认为null,使用分支的head。不能与标记参数一起使用。
标签 The tag to build. Default is null. Cannot be used with revision parameter.
平行 用于运行构建的容器的数量。默认为null,使用项目默认值。在2.0基础架构上运行的构建,忽略此参数。
生成\u参数 Additional environment variables to inject into the build environment. A map of names to values.

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

Trigger a new Job with a Branch

curl -X POST --header“内容类型:应用程序/ JSON”-H"Circle-Token: "-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.
{"author_name"“艾伦罗纳”"build_url""//www.drag240sx.com/gh/circleci/mongofinil/54"“reponame”“蒙哥菲尔”"failed"空值“基础设施故障”错误的"canceled"错误的“所有提交详细信息”[{"author_name"“艾伦罗纳”“提交”“F1BAEB913288519DD9A942499CEF2873F5B1C2BF”"author_login"“阿罗纳”"committer_login"“阿罗纳”“committer_name”“艾伦罗纳”“身体”“次要版本碰撞”"author_date"“2014-04-17T08:41:40z”“committ_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""subject"“来自circleci/minor version bump的合并请求#15”}]那"previous"{“build_num”5.3"status"“成功”“build_time_millis”55413.}那“ssh_enabled”空值“author_email”"arohner@gmail.com""why"“编辑”“build_time_millis”空值“committer_email”"arohner@gmail.com""parallel"2"retries"空值“比较”空值"dont_build"空值“committer_name”“艾伦罗纳”"usage_queued_at"“2014-04-29T12:56:55.338Z”“分支”“掌握”“身体”“次要版本碰撞”"author_date"“2014-04-17T08:41:40z”"node"空值“committ_date”“2014-04-17T08:41:40z”“开始时间”空值“stop_time”空值“生命周期”“not_running”//queuedschedulednot_runnot_running跑步or完成"user"{“电子邮件”"arohner@gmail.com"“名称”“艾伦罗纳”“登录”“阿罗纳”“is_user”真的}那"subject"“来自circleci/minor version bump的合并请求#15”“消息”[],"job_name"空值“retry_of”空值“previous_successful_build”{“build_num”5.3"status"“成功”“build_time_millis”55413.}那“结果”空值"status"“not_running”“vcs_revision”“F1BAEB913288519DD9A942499CEF2873F5B1C2BF”“build_num”5.4"username""circleci""vcs_url"“https://github.com/circleci/mongofinil”“时间到”错误的}

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

范围 Description
修订 建立的具体修订。默认为null,使用分支的head。不能与标记参数一起使用。
平行 用于运行构建的容器的数量。默认为null,使用项目默认值。在2.0基础架构上运行的构建,忽略此参数。
生成\u参数 Additional environment variables to inject into the build environment. A map of names to values.

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

Trigger a new Build by Project (preview)

curl -x post //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/build -h"Circle-Token: "
{"status"200.“身体”"Build created"}

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

范围 Description
修订 建立的具体修订。If not specified, the HEAD of the branch is used. Cannot be used with tag parameter
分支 The branch to build. Cannot be used with tag parameter.
标签 git标记要构建。不能与分支和修订参数一起使用。

Get Build Test Metadata

curl //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/tests -H"Circle-Token: "
{"tests"[{"message"“文件”"features/desktop/invitations.feature""source""cucumber"“运行时间”2.957513661“结果”“成功”“名称”“接受邀请”“类名”“邀请”}那{"message"空值“文件”"spec/lib/webfinger_spec.rb""source""rspec"“运行时间”0.011366“结果”“成功”“名称”“webfinger#intialize sets帐户”“类名”“spec.lib.webfinger_spec”}]}

GETRequestProvides test metadata for a build.

Keys

列出结帐密钥

卷曲//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/checkout -key -h."Circle-Token: "
[{“public_key”"ssh-rsa...""type"“部署密钥”//可以“部署密钥”or"github-user-key"“指纹”"c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f""preferred"真的“时间”“2015-09-21T17:29:21.042Z”//whenkeywas是sued}]

GETRequest:返回的签出键数组:项目。

New Checkout Key

curl -X POST --header“内容类型:应用程序/ JSON”-D.'{“类型”:“github-user-key”}“//www.drag240sx.com/api/v1.1/project/:vcs type/:username/:project/checkout键-H"Circle-Token: "
{“public_key”"ssh-rsa...""type"“部署密钥”//可以“部署密钥”or“用户密钥”“指纹”"c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f""preferred"真的“时间”“2015-09-21T17:29:21.042Z”//whenkeywas是sued}

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

范围 Description
type The type of key to create. Can be 'deploy-key' or 'github-user-key'.

Get Checkout Key

curl //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/checkout -key/:fingerprint -h."Circle-Token: "
{“public_key”"ssh-rsa...""type"“部署密钥”//可以“部署密钥”or“用户密钥”“指纹”"c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f""preferred"真的“时间”“2015-09-21T17:29:21.042Z”//whenkeywas是sued}

GETRequest:Returns an individual checkout key.

Delete Checkout Key

DELETE请求:Deletes the checkout key.

curl -X DELETE //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/checkout-key/:fingerprint -H"Circle-Token: "
{"message""ok"}

创建SSH键

邮政请求:Creates an SSH key that will be used to access the external system identified by the hostname parameter for SSH key-based authentication.

curl -X POST --header“内容类型:应用程序/ JSON”-D.'{"hostname":"hostname","private_key":"RSA private key"}'//www.drag240sx.com/api/v1.1/project/:vcs type/:username/:project/ssh key-H"Circle-Token: "
# no response expected

删除SSH键

curl-X DELETE—标题“内容类型:应用程序/ JSON”-D.{“指纹”“指纹”“主机名”"Hostname"}//www.drag240sx.com/api/v1.1/project/:vcs type/:username/:project/ssh key-H"Circle-Token: "
# no response expected

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

Heroku钥匙

邮政请求:将您的Heroku API键添加到Circleci,然后采取一种pikey一种s form param name.

curl -X POST --header“内容类型:应用程序/ JSON”-D.'{"apikey":"Heroku key"}'//www.drag240sx.com/user/heroku -key -h."Circle-Token: "
# no response expected

伪影

构建的工件

卷曲//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/artifacts -h"Circle-Token: "
[{"path"“原始测试输出/ 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"}那{"path"“原始测试输出/ 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"}]

Returns an array of artifacts produced by a given build. Request Type:GET

笔记s

Download an artifact file

You can download an individual artifact file via the API with an API-token authenticated HTTP request.

curl -l https://132-55688803-gh.circle-artifacts.com/0//tmp/circle-artifacts.7wgaaiu/file.txt-h"Circle-Token: "

笔记s

最新版本的工件

curl //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/latest/artifacts?branch.=:分支机滤波器=:过滤器-H."Circle-Token: "
[{"path"“原始测试输出/ 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"}那{"path"“原始测试输出/ 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"}]

返回一个数组的工件产生的迟了st build on a given branch.

请求类型:GET

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

笔记s

环境变量

列出环境变量

curl //www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/envvar -H"Circle-Token: "
[{“名称”“foo”"value""xxxx1234"}]

GETRequest:Returns four 'x' characters plus the last four ASCII characters of the value, consistent with the display of environment variable values in the CircleCI website.

Add Environment Variables

curl -X POST --header“内容类型:应用程序/ JSON”-D.'{"name":"foo", "value":"bar"}'//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/envvar -h"Circle-Token: "
{“名称”“foo”"value"“xxxx号”}

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

获取单个环境变量

卷曲//www.drag240sx.com/api/v1.1/project/:vcs-type/:username/:project/envvar/:name -h"Circle-Token: "
{“名称”“foo”"value"“xxxx号”}

GET请求:返回环境变量的隐藏值:name

Delete Environment Variables

curl -x删除//www.drag240sx.com/api/v1.1/project/:vcs-type/:ususername/:project/envvar/:name -h"Circle-Token: "
{"message""ok"}

DELETERequestDeletes the environment variable named :name.