Automate CircleCI

What CircleCI is

The CircleCI API is a RESTful, fully-featured API that allows you to do almost anything in CircleCI. You can access all information and trigger all actions. The only thing we don’t provide access to is billing functions, which must be done from the CircleCI web UI.

API host: circleci.com

Things people automate with CircleCI

• Get a Slack alert when a CircleCI deploy finishes or failsCircleCI → Slack
• Get a Telegram alert when a CircleCI deploy finishes or failsCircleCI → Telegram
• Get a Google Chat alert when a CircleCI deploy finishes or failsCircleCI → Google Chat

What HumDay can do in CircleCI

11 documented operations change something in CircleCI.

• POSTAdds your Heroku API key to CircleCI, takes apikey as form param name./user/heroku-key
• POSTCreates a new environment variable/project/{username}/{project}/envvar
• POSTCreates a new checkout key./project/{username}/{project}/checkout-key
• POSTTriggers a new build, returns a summary of the build./project/{username}/{project}
• POSTCreate an ssh key used to access external systems that require SSH key-based authentication/project/{username}/{project}/ssh-key
• POSTTriggers a new build, returns a summary of the build./project/{username}/{project}/tree/{branch}
• POSTRetries the build, returns a summary of the new build./project/{username}/{project}/{build_num}/retry
• DELETEClears the cache for a project./project/{username}/{project}/build-cache
• DELETEDeletes the environment variable named ':name'/project/{username}/{project}/envvar/{name}
• POSTCancels the build, returns a summary of the build./project/{username}/{project}/{build_num}/cancel
• DELETEDelete a checkout key./project/{username}/{project}/checkout-key/{fingerprint}

What HumDay can read from CircleCI

These are the operations a schedule or a trigger can watch.

• GETProvides information about the signed in user./me
• GETList of all the projects you're following on CircleCI, with build information organized by branch./projects
• GETBuild summary for each of the last 30 recent builds, ordered by buildnum./recent-builds
• GETBuild summary for each of the last 30 builds for a single git repo./project/{username}/{project}
• GETList the artifacts produced by a given build./project/{username}/{project}/{build_num}/artifacts
• GETLists the environment variables for:project/project/{username}/{project}/envvar
• GETLists checkout keys./project/{username}/{project}/checkout-key
• GETFull details for a single build./project/{username}/{project}/{build_num}
• GETGets the hidden value of environment variable:name/project/{username}/{project}/envvar/{name}
• GETProvides test metadata for a build Note: Learn how to set up your builds to collect test metadata/project/{username}/{project}/{build_num}/tests
• GETGet a checkout key./project/{username}/{project}/checkout-key/{fingerprint}

How automating CircleCI works

1. Describe the outcome. Say what you want to happen, in your own words. No node graphs, no field mapping.
2. Approve the contract. HumDay writes down exactly what it will do, what it will touch, and what it will never do. You approve it before anything is built.
3. See it proven. The program runs and shows you the result before it is allowed near your live CircleCI account.
4. Grant access, then go live. You approve the specific CircleCI operations it may use — and only those.

Popular CircleCI integrations

Connect CircleCI to the tools people pair it with most.

• CircleCI and OData for namespace microsoft.graphintegration
• CircleCI and Cloudflareintegration
• CircleCI and NetBoxintegration
• CircleCI and GitHubintegration
• CircleCI and Mistintegration
• CircleCI and Loket.nlintegration
• CircleCI and Atlassian The Jira Cloud platformintegration
• CircleCI and Magento B2Bintegration
• CircleCI and Stripeintegration
• CircleCI and Zuora Reference Billingintegration
• CircleCI and bunqintegration
• CircleCI and DocuSignintegration

Automate CircleCI with these

• OData for namespace microsoft.graph11412 operations
• GitHub811 operations
• Atlassian The Jira Cloud platform474 operations
• Gitlab358 operations
• JIRA 7.6.1324 operations
• Appcenter App Center Client323 operations
• Gitea .321 operations
• Bitbucket292 operations
• Keycloak Admin281 operations
• Apple App Store Connect251 operations
• Files.com222 operations
• Vmware vRealize Network Insight Reference161 operations

Categories

• Developer tools

Questions about CircleCI automation

Can HumDay connect to CircleCI?

Yes. HumDay reads CircleCI's own published API description and derives the operations from it, so there is no hand-built connector to wait for. 22 operations are documented.

Do I need to write code to automate CircleCI?

No. You describe the outcome you want in plain words. HumDay agrees a contract with you, writes the program, and shows you a test run before anything touches your CircleCI account.

What can HumDay do in CircleCI?

11 of the 22 documented operations change something in CircleCI, and 11 read from it. HumDay only ever uses the specific operations your approved contract needs.

Is my CircleCI account safe?

Your credentials are stored encrypted and are never shown in chat, code, or logs. Every run is limited to the operations you explicitly approved, and anything that writes to CircleCI is held behind that approval.

Where this came from

The operations above are read from a published API description for CircleCI at raw.githubusercontent.com/kamikazechaser/spec-circleci/master/swagger.yml. Descriptions are the provider’s own words, not ours. Last published 2021-06-21.