Codeship API

Name: Codeship API API
Brand: Codeship API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsCi Cdbearer14 EndpointsREST

For Agents

Authenticate to Codeship, trigger and inspect builds, and read pipelines, services, and steps for Codeship Basic and Pro projects.

Connect the Codeship API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Codeship API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Codeship API API.

Exchange username and password for a JWT bearer token via /auth

List and create projects under a Codeship organization

Read a project's configuration including AES key for encrypted env vars

Trigger a new build for a project on a specific commit or branch

GET STARTED

Start building with Codeship API API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Codeship API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Codeship API, keeping it validated and agent-ready. Codeship API v2 is the REST interface for the Codeship SaaS CI/CD platform, now part of CloudBees. Endpoints cover authentication via username and password to obtain a JWT, listing and managing projects under an organization, triggering and inspecting builds, restarting or stopping a running build, and reading the build's pipelines, services, and steps for both Basic and Pro project types. Resources are scoped to an organization UUID returned in the auth response.

Use Cases

Patterns agents use Codeship API API for, with concrete tasks.

★ Build Triggering From External Systems

Trigger Codeship builds from chatops, scheduling tools, or release-management software by calling POST /organizations/{organization_uuid}/projects/{project_uuid}/builds with the target commit SHA or branch. The endpoint queues the build and returns its UUID, which downstream tooling can poll for status. This replaces manual 'rebuild' clicks in the Codeship UI for routine release flows.

POST a build for project_uuid on branch=main with the latest commit SHA, then poll the build UUID for status

Build Status Aggregation

Aggregate build status across Codeship projects into a release dashboard. GET /organizations/{organization_uuid}/projects/{project_uuid}/builds returns recent builds and GET /organizations/{organization_uuid}/projects/{project_uuid}/builds/{build_uuid} returns per-build detail. For Codeship Pro projects, the pipelines, services, and steps endpoints expose the full DAG so a dashboard can highlight which step in the pipeline failed.

Iterate projects, fetch the latest build for each, and report any whose status is failed in the past 24 hours

Failure Recovery Automations

Automatically restart a build that failed due to flake or upstream outage by calling /builds/{build_uuid}/restart, or stop a runaway build that would otherwise consume the parallel slot via /builds/{build_uuid}/stop. Combined with status polling, this is the standard self-healing pattern for CI fleets that run thousands of builds per week.

If a build's status is 'error' and the failure log indicates a network timeout, POST to /builds/{build_uuid}/restart

Secret Rotation

Rotate the AES encryption key used by a Codeship project for encrypted environment variables. POST /organizations/{organization_uuid}/projects/{project_uuid}/reset_aes_key issues a new key, which the team then uses to re-encrypt the project's secrets file. This is the canonical key-rotation flow when an engineer with access leaves or a key is suspected to be compromised.

Call /reset_aes_key on the project and then re-encrypt the local env.encrypted file with the new key

Agent-Driven CI Operations via Jentic

AI assistants for platform teams can answer 'restart the failed payment-service build' by searching Jentic for an intent and executing the matching Codeship operation. The Codeship JWT lives in the Jentic vault and a scoped credential is issued per call, so the long-lived auth response never enters the agent's context.

Search Jentic for 'restart codeship build', load the /restart operation, and execute it for the named build_uuid

Key Endpoints

14 endpoints — jentic publishes the only available openapi specification for codeship api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/auth

Exchange credentials for a JWT

GET

/organizations/{organization_uuid}/projects

List projects in an organization

POST

/organizations/{organization_uuid}/projects/{project_uuid}/builds

Trigger a build

GET

/organizations/{organization_uuid}/projects/{project_uuid}/builds/{build_uuid}

Get a build by UUID

POST

/organizations/{organization_uuid}/projects/{project_uuid}/builds/{build_uuid}/stop

Stop a running build

POST

/organizations/{organization_uuid}/projects/{project_uuid}/builds/{build_uuid}/restart

Restart a build

GET

/organizations/{organization_uuid}/projects/{project_uuid}/builds/{build_uuid}/pipelines

List pipelines for a Pro build

POST

/organizations/{organization_uuid}/projects/{project_uuid}/reset_aes_key

Rotate the project's AES encryption key

POST

/auth

Exchange credentials for a JWT

GET

/organizations/{organization_uuid}/projects

List projects in an organization

POST

/organizations/{organization_uuid}/projects/{project_uuid}/builds

Trigger a build

GET

/organizations/{organization_uuid}/projects/{project_uuid}/builds/{build_uuid}

Get a build by UUID

POST

/organizations/{organization_uuid}/projects/{project_uuid}/builds/{build_uuid}/stop

Stop a running build

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Codeship usernames, passwords, and the resulting JWT are all stored encrypted in the Jentic vault. Agents receive a per-call scoped bearer token, so the long-lived JWT never enters the agent's context or logs.

Intent-based discovery

Agents search Jentic with intents like 'trigger codeship build' or 'restart build' and Jentic returns the matching operation with its parameter schema, removing the need to read the Codeship reference docs.

Time to first call

Direct Codeship integration: half a day to handle JWT exchange, organization-scoped routing, and Pro vs Basic project differences. Through Jentic: under 30 minutes — search, load, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

CircleCI

Hosted CI/CD platform with config-as-code and orbs.

Choose CircleCI when starting greenfield SaaS-hosted CI; use Codeship when staying on the CloudBees portfolio with existing Codeship projects.

Alternative

Buildkite

Hybrid CI with hosted control plane and self-hosted build agents.

Choose Buildkite when builds must run on your own infrastructure; Codeship runs on Codeship-hosted machines.

Complementary

CloudBees CI

Enterprise Jenkins controller from the same vendor.

Use CloudBees CI for self-hosted enterprise Jenkins workloads and Codeship for SaaS-hosted CI under the same CloudBees account.

Complementary

GitHub

Source-of-truth for code that drives Codeship builds.

Use GitHub APIs to react to PR events, then call Codeship to trigger or restart the corresponding build.

FAQs

Specific to using Codeship API API through Jentic.

Why is there no official OpenAPI spec for Codeship API?

CloudBees does not publish an OpenAPI specification for the Codeship API. Jentic generates and maintains this spec so that AI agents and developers can call Codeship API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Codeship API use?

Codeship uses a JWT bearer token. POST /auth with the user's Codeship username and password returns a JWT plus the organization UUIDs the user belongs to. Through Jentic, credentials and the resulting JWT live in the vault and a scoped bearer token is issued per call.

Can I restart a failed build with this API?

Yes. POST /organizations/{organization_uuid}/projects/{project_uuid}/builds/{build_uuid}/restart re-runs the same build without requiring a new commit, which is useful for transient failures. POST /stop on the same path cancels a build that is still running.

What are the rate limits for the Codeship API?

Codeship does not publish an explicit rate limit in this spec. Treat the API as low-volume control plane traffic — back off on 429 responses and avoid bursting more than a few requests per second per JWT, especially for build creation.

How do I trigger a Codeship build through Jentic?

Run pip install jentic, search for 'trigger a codeship build', load the POST /organizations/{organization_uuid}/projects/{project_uuid}/builds operation, then execute with the target ref or commit SHA. The call returns the new build UUID.

Does this API expose pipelines and steps for Codeship Pro?

Yes. /builds/{build_uuid}/pipelines, /builds/{build_uuid}/services, and /builds/{build_uuid}/steps return the per-pipeline DAG, the services Codeship Pro spun up, and the individual steps with their statuses.