How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenShift BuildConfigs API

Manage build configuration templates that define how to transform source code into container images using Source, Docker, or Custom build strategies with configurable triggers.

OpenShift BuildConfigs API is one of 31 APIs that OpenShift publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include BuildConfigs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, pricing, a support channel, and rate-limit docs.

This API exposes 7 operations across 4 paths, and defines 23 schemas. It is described by OpenAPI 3.1.0, at version 4.17.0.

Requests are made against a single base URL, https://api.openshift.com.

7 operations 4 paths 23 schemas 1 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.17.0
Base URL
https://api.openshift.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

OpenShift BuildConfigs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerToken). By default, every request must be authenticated.

  • BearerToken — OAuth bearer token obtained from the OpenShift OAuth server. Use 'oc whoami -t' to retrieve a token, or configure an OAuth client for programmatic access.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

BuildConfigs 7

Manage build configuration templates that define how to transform source code into container images using Source, Docker, or Custom build strategies with configurable triggers.

GET
/apis/build.openshift.io/v1/buildconfigs
Openshift List Build Configs Across All Namespaces
listBuildConfigForAllNamespaces 8 params → 200401
GET
/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs
Openshift List Build Configs in a Namespace
listNamespacedBuildConfig 9 params → 200401
POST
/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs
Openshift Create a Build Config
createNamespacedBuildConfig 4 params body → 200201202401
GET
/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}
Openshift Read a Build Config
readNamespacedBuildConfig 3 params → 200401
PUT
/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}
Openshift Replace a Build Config
replaceNamespacedBuildConfig 5 params body → 200201401
DELETE
/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}
Openshift Delete a Build Config
deleteNamespacedBuildConfig 6 params → 200202401
POST
/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate
Openshift Instantiate a Build From a Build Config
createNamespacedBuildConfigInstantiate 5 params body → 200201401

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are ObjectMeta (11 properties), BuildConfigSpec (11 properties), BuildStatus (11 properties), BuildSpec (8 properties). Each schema is shown below with its type and property counts.

BuildConfigList
object
A list of BuildConfig objects.
4 properties 1 required
DockerBuildStrategy
object
Docker build strategy that uses a Dockerfile to build images.
6 properties
ObjectReference
object
A reference to a Kubernetes object.
4 properties
BuildSource
object
Specifies the source code location and type for the build input.
5 properties
BuildOutput
object
Specifies where the resulting container image is pushed.
2 properties
BuildSpec
object
Specification of the desired build behavior.
8 properties
ResourceRequirements
object
Compute resource requirements for a container.
2 properties
OwnerReference
object
Contains information to identify an owning object.
6 properties 4 required
BuildTriggerPolicy
object
A policy that causes a new build to be created.
4 properties
EnvVar
object
An environment variable to set in a container.
2 properties 1 required
BuildRequest
object
A request to instantiate a new build from a BuildConfig.
5 properties
Status
object
Status is a return value for calls that do not return other objects.
7 properties
BuildConfigStatus
object
Status of the BuildConfig.
2 properties
ListMeta
object
Metadata for list responses including pagination tokens.
4 properties
CustomBuildStrategy
object
Custom build strategy that uses a custom builder image to execute an arbitrary build process.
4 properties 1 required
BuildStrategy
object
Describes how to perform the build.
4 properties
BuildConfig
object
A BuildConfig defines the build strategy and source used to produce new container images. Builds can be triggered automatically by webhooks, image changes, or…
5 properties 1 required
BuildConfigSpec
object
Specification of the desired BuildConfig behavior.
11 properties
SourceBuildStrategy
object
Source-to-Image (S2I) build strategy that combines application source with a builder image to produce a runnable image.
5 properties 1 required
BuildStatus
object
Status of the build execution.
11 properties
Build
object
A Build represents a single execution of a build process that transforms source code into a runnable container image. Builds are created from BuildConfigs or i…
5 properties 1 required
BuildTriggerCause
object
Records which event triggered the build.
1 property
ObjectMeta
object
Standard Kubernetes object metadata. Every resource includes metadata such as name, namespace, labels, and annotations.
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openshift-buildconfigs-api-openapi.yml Raw ↑

Other APIs OpenShift publishes across the network.

OpenShift OAuth API
OpenShift Routes API
OpenShift Build API
OpenShift Image API
OpenShift Project API
OpenShift Workloads API
OpenShift Network API
OpenShift Storage API
OpenShift Authorization API
OpenShift Autoscale API
OpenShift Config API
OpenShift Console API
Where this information came from

This is an independent, third-party profile of OpenShift BuildConfigs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.