BuildRequest [build.openshift.io/v1] - Workloads APIs | API reference

Specification
API endpoints
- /apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/clone
- /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate

Description: BuildRequest is the resource used to pass parameters to build generator

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
Type: object

Specification

Property Type Description

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`binary`	`object`	BinaryBuildSource describes a binary file to be used for the Docker and Source build strategies, where the file will be extracted and used as the build source.
`dockerStrategyOptions`	`object`	DockerStrategyOptions contains extra strategy options for container image builds
`env`	`array (EnvVar)`	env contains additional environment variables you want to pass into a builder container.
`from`	`ObjectReference`	from is the reference to the ImageStreamTag that triggered the build.
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`lastVersion`	`integer`	lastVersion (optional) is the LastVersion of the BuildConfig that was used to generate the build. If the BuildConfig in the generator doesn’t match, a build will not be generated.
`metadata`	`ObjectMeta_v2`	metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`revision`	`object`	SourceRevision is the revision or commit information from the source for the build
`sourceStrategyOptions`	`object`	SourceStrategyOptions contains extra strategy options for Source builds
`triggeredBy`	`array`	triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers.
`triggeredBy[]`	`object`	BuildTriggerCause holds information about a triggered build. It is used for displaying build trigger data for each build and build configuration in oc describe. It is also used to describe which triggers led to the most recent update in the build configuration.
`triggeredByImage`	`ObjectReference`	triggeredByImage is the Image that triggered this build.

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

binary

object

BinaryBuildSource describes a binary file to be used for the Docker and Source build strategies, where the file will be extracted and used as the build source.

dockerStrategyOptions

object

DockerStrategyOptions contains extra strategy options for container image builds

env

array (EnvVar)

env contains additional environment variables you want to pass into a builder container.

from

ObjectReference

from is the reference to the ImageStreamTag that triggered the build.

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

lastVersion

integer

lastVersion (optional) is the LastVersion of the BuildConfig that was used to generate the build. If the BuildConfig in the generator doesn’t match, a build will not be generated.

metadata

ObjectMeta_v2

metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

revision

object

SourceRevision is the revision or commit information from the source for the build

sourceStrategyOptions

object

SourceStrategyOptions contains extra strategy options for Source builds

triggeredBy

array

triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers.

triggeredBy[]

object

BuildTriggerCause holds information about a triggered build. It is used for displaying build trigger data for each build and build configuration in oc describe. It is also used to describe which triggers led to the most recent update in the build configuration.

triggeredByImage

ObjectReference

triggeredByImage is the Image that triggered this build.

.binary

Description: BinaryBuildSource describes a binary file to be used for the Docker and Source build strategies, where the file will be extracted and used as the build source.
Type: object

Property Type Description

Property	Type	Description
`asFile`	`string`	asFile indicates that the provided binary input should be considered a single file within the build input. For example, specifying "webapp.war" would place the provided binary as `/webapp.war` for the builder. If left empty, the Docker and Source build strategies assume this file is a zip, tar, or tar.gz file and extract it as the source. The custom strategy receives this binary as standard input. This filename may not contain slashes or be '..' or '.'.

asFile

string

asFile indicates that the provided binary input should be considered a single file within the build input. For example, specifying "webapp.war" would place the provided binary as /webapp.war for the builder. If left empty, the Docker and Source build strategies assume this file is a zip, tar, or tar.gz file and extract it as the source. The custom strategy receives this binary as standard input. This filename may not contain slashes or be '..' or '.'.

.dockerStrategyOptions

Description: DockerStrategyOptions contains extra strategy options for container image builds
Type: object

Property Type Description

Property	Type	Description
`buildArgs`	`array (EnvVar)`	Args contains any build arguments that are to be passed to Docker. See https://docs.docker.com/engine/reference/builder/#/arg for more details
`noCache`	`boolean`	noCache overrides the docker-strategy noCache option in the build config

buildArgs

array (EnvVar)

Args contains any build arguments that are to be passed to Docker. See https://docs.docker.com/engine/reference/builder/#/arg for more details

noCache

boolean

noCache overrides the docker-strategy noCache option in the build config

.revision

Description

SourceRevision is the revision or commit information from the source for the build

Type

object

Required

type

Property Type Description

Property	Type	Description
`git`	`object`	GitSourceRevision is the commit information from a git source for a build
`type`	`string`	type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'

git

object

GitSourceRevision is the commit information from a git source for a build

type

string

type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'

.revision.git

Description: GitSourceRevision is the commit information from a git source for a build
Type: object

Property Type Description

Property	Type	Description
`author`	`object`	SourceControlUser defines the identity of a user of source control
`commit`	`string`	commit is the commit hash identifying a specific commit
`committer`	`object`	SourceControlUser defines the identity of a user of source control
`message`	`string`	message is the description of a specific commit

author

object

SourceControlUser defines the identity of a user of source control

commit

string

commit is the commit hash identifying a specific commit

committer

object

SourceControlUser defines the identity of a user of source control

message

string

message is the description of a specific commit

.revision.git.author

Description: SourceControlUser defines the identity of a user of source control
Type: object

Property Type Description

Property	Type	Description
`email`	`string`	email of the source control user
`name`	`string`	name of the source control user

email

string

email of the source control user

name

string

name of the source control user

.revision.git.committer

Description: SourceControlUser defines the identity of a user of source control
Type: object

Property Type Description

Property	Type	Description
`email`	`string`	email of the source control user
`name`	`string`	name of the source control user

email

string

email of the source control user

name

string

name of the source control user

.sourceStrategyOptions

Description: SourceStrategyOptions contains extra strategy options for Source builds
Type: object

Property Type Description

Property	Type	Description
`incremental`	`boolean`	incremental overrides the source-strategy incremental option in the build config

incremental

boolean

incremental overrides the source-strategy incremental option in the build config

.triggeredBy

Description: triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers.
Type: array

.triggeredBy[]

Description: BuildTriggerCause holds information about a triggered build. It is used for displaying build trigger data for each build and build configuration in oc describe. It is also used to describe which triggers led to the most recent update in the build configuration.
Type: object

Property Type Description

Property	Type	Description
`bitbucketWebHook`	`object`	BitbucketWebHookCause has information about a Bitbucket webhook that triggered a build.
`genericWebHook`	`object`	GenericWebHookCause holds information about a generic WebHook that triggered a build.
`githubWebHook`	`object`	GitHubWebHookCause has information about a GitHub webhook that triggered a build.
`gitlabWebHook`	`object`	GitLabWebHookCause has information about a GitLab webhook that triggered a build.
`imageChangeBuild`	`object`	ImageChangeCause contains information about the image that triggered a build
`message`	`string`	message is used to store a human readable message for why the build was triggered. E.g.: "Manually triggered by user", "Configuration change",etc.

bitbucketWebHook

object

BitbucketWebHookCause has information about a Bitbucket webhook that triggered a build.

genericWebHook

object

GenericWebHookCause holds information about a generic WebHook that triggered a build.

githubWebHook

object

GitHubWebHookCause has information about a GitHub webhook that triggered a build.

gitlabWebHook

object

GitLabWebHookCause has information about a GitLab webhook that triggered a build.

imageChangeBuild

object

ImageChangeCause contains information about the image that triggered a build

message

string

message is used to store a human readable message for why the build was triggered. E.g.: "Manually triggered by user", "Configuration change",etc.

.triggeredBy[].bitbucketWebHook

Description: BitbucketWebHookCause has information about a Bitbucket webhook that triggered a build.
Type: object

Property Type Description

Property	Type	Description
`revision`	`object`	SourceRevision is the revision or commit information from the source for the build
`secret`	`string`	secret is the obfuscated webhook secret that triggered a build.

revision

object

SourceRevision is the revision or commit information from the source for the build

secret

string

secret is the obfuscated webhook secret that triggered a build.

.triggeredBy[].bitbucketWebHook.revision

Description

SourceRevision is the revision or commit information from the source for the build

Type

object

Required

type

Property Type Description

Property	Type	Description
`git`	`object`	GitSourceRevision is the commit information from a git source for a build
`type`	`string`	type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'

git

object

GitSourceRevision is the commit information from a git source for a build

type

string

type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'

.triggeredBy[].bitbucketWebHook.revision.git

Description: GitSourceRevision is the commit information from a git source for a build
Type: object

Property Type Description

Property	Type	Description
`author`	`object`	SourceControlUser defines the identity of a user of source control
`commit`	`string`	commit is the commit hash identifying a specific commit
`committer`	`object`	SourceControlUser defines the identity of a user of source control
`message`	`string`	message is the description of a specific commit

author

object

SourceControlUser defines the identity of a user of source control

commit

string

commit is the commit hash identifying a specific commit

committer

object

SourceControlUser defines the identity of a user of source control

message

string

message is the description of a specific commit

.triggeredBy[].bitbucketWebHook.revision.git.author

Description: SourceControlUser defines the identity of a user of source control
Type: object

Property Type Description

Property	Type	Description
`email`	`string`	email of the source control user
`name`	`string`	name of the source control user

email

string

email of the source control user

name

string

name of the source control user

.triggeredBy[].bitbucketWebHook.revision.git.committer

Description: SourceControlUser defines the identity of a user of source control
Type: object

Property Type Description

Property	Type	Description
`email`	`string`	email of the source control user
`name`	`string`	name of the source control user

email

string

email of the source control user

name

string

name of the source control user

.triggeredBy[].genericWebHook

Description: GenericWebHookCause holds information about a generic WebHook that triggered a build.
Type: object

Property Type Description

Property	Type	Description
`revision`	`object`	SourceRevision is the revision or commit information from the source for the build
`secret`	`string`	secret is the obfuscated webhook secret that triggered a build.

revision

object

SourceRevision is the revision or commit information from the source for the build

secret

string

secret is the obfuscated webhook secret that triggered a build.

.triggeredBy[].genericWebHook.revision

Description

SourceRevision is the revision or commit information from the source for the build

Type

object

Required

type

Property Type Description

Property	Type	Description
`git`	`object`	GitSourceRevision is the commit information from a git source for a build
`type`	`string`	type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'

git

object

GitSourceRevision is the commit information from a git source for a build

type

string

type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'

.triggeredBy[].genericWebHook.revision.git

Description: GitSourceRevision is the commit information from a git source for a build
Type: object

Property Type Description

Property	Type	Description
`author`	`object`	SourceControlUser defines the identity of a user of source control
`commit`	`string`	commit is the commit hash identifying a specific commit
`committer`	`object`	SourceControlUser defines the identity of a user of source control
`message`	`string`	message is the description of a specific commit

author

object

SourceControlUser defines the identity of a user of source control

commit

string

commit is the commit hash identifying a specific commit

committer

object

SourceControlUser defines the identity of a user of source control

message

string

message is the description of a specific commit

.triggeredBy[].genericWebHook.revision.git.author

Description: SourceControlUser defines the identity of a user of source control
Type: object

Property Type Description

Property	Type	Description
`email`	`string`	email of the source control user
`name`	`string`	name of the source control user

email

string

email of the source control user

name

string

name of the source control user

.triggeredBy[].genericWebHook.revision.git.committer

Description: SourceControlUser defines the identity of a user of source control
Type: object

Property Type Description

Property	Type	Description
`email`	`string`	email of the source control user
`name`	`string`	name of the source control user

email

string

email of the source control user

name

string

name of the source control user

.triggeredBy[].githubWebHook

Description: GitHubWebHookCause has information about a GitHub webhook that triggered a build.
Type: object

Property Type Description

Property	Type	Description
`revision`	`object`	SourceRevision is the revision or commit information from the source for the build
`secret`	`string`	secret is the obfuscated webhook secret that triggered a build.

revision

object

SourceRevision is the revision or commit information from the source for the build

secret

string

secret is the obfuscated webhook secret that triggered a build.

.triggeredBy[].githubWebHook.revision

Description

SourceRevision is the revision or commit information from the source for the build

Type

object

Required

type

Property Type Description

Property	Type	Description
`git`	`object`	GitSourceRevision is the commit information from a git source for a build
`type`	`string`	type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'

git

object

GitSourceRevision is the commit information from a git source for a build

type

string

type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'

.triggeredBy[].githubWebHook.revision.git

Description: GitSourceRevision is the commit information from a git source for a build
Type: object

Property Type Description

Property	Type	Description
`author`	`object`	SourceControlUser defines the identity of a user of source control
`commit`	`string`	commit is the commit hash identifying a specific commit
`committer`	`object`	SourceControlUser defines the identity of a user of source control
`message`	`string`	message is the description of a specific commit

author

object

SourceControlUser defines the identity of a user of source control

commit

string

commit is the commit hash identifying a specific commit

committer

object

SourceControlUser defines the identity of a user of source control

message

string

message is the description of a specific commit

.triggeredBy[].githubWebHook.revision.git.author

Description: SourceControlUser defines the identity of a user of source control
Type: object

Property Type Description

Property	Type	Description
`email`	`string`	email of the source control user
`name`	`string`	name of the source control user

email

string

email of the source control user

name

string

name of the source control user

.triggeredBy[].githubWebHook.revision.git.committer

Description: SourceControlUser defines the identity of a user of source control
Type: object

Property Type Description

Property	Type	Description
`email`	`string`	email of the source control user
`name`	`string`	name of the source control user

email

string

email of the source control user

name

string

name of the source control user

.triggeredBy[].gitlabWebHook

Description: GitLabWebHookCause has information about a GitLab webhook that triggered a build.
Type: object

Property Type Description

Property	Type	Description
`revision`	`object`	SourceRevision is the revision or commit information from the source for the build
`secret`	`string`	secret is the obfuscated webhook secret that triggered a build.

revision

object

SourceRevision is the revision or commit information from the source for the build

secret

string

secret is the obfuscated webhook secret that triggered a build.

.triggeredBy[].gitlabWebHook.revision

Description

SourceRevision is the revision or commit information from the source for the build

Type

object

Required

type

Property Type Description

Property	Type	Description
`git`	`object`	GitSourceRevision is the commit information from a git source for a build
`type`	`string`	type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'

git

object

GitSourceRevision is the commit information from a git source for a build

type

string

type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'

.triggeredBy[].gitlabWebHook.revision.git

Description: GitSourceRevision is the commit information from a git source for a build
Type: object

Property Type Description

Property	Type	Description
`author`	`object`	SourceControlUser defines the identity of a user of source control
`commit`	`string`	commit is the commit hash identifying a specific commit
`committer`	`object`	SourceControlUser defines the identity of a user of source control
`message`	`string`	message is the description of a specific commit

author

object

SourceControlUser defines the identity of a user of source control

commit

string

commit is the commit hash identifying a specific commit

committer

object

SourceControlUser defines the identity of a user of source control

message

string

message is the description of a specific commit

.triggeredBy[].gitlabWebHook.revision.git.author

Description: SourceControlUser defines the identity of a user of source control
Type: object

Property Type Description

Property	Type	Description
`email`	`string`	email of the source control user
`name`	`string`	name of the source control user

email

string

email of the source control user

name

string

name of the source control user

.triggeredBy[].gitlabWebHook.revision.git.committer

Description: SourceControlUser defines the identity of a user of source control
Type: object

Property Type Description

Property	Type	Description
`email`	`string`	email of the source control user
`name`	`string`	name of the source control user

email

string

email of the source control user

name

string

name of the source control user

.triggeredBy[].imageChangeBuild

Description: ImageChangeCause contains information about the image that triggered a build
Type: object

Property Type Description

Property	Type	Description
`fromRef`	`ObjectReference`	fromRef contains detailed information about an image that triggered a build.
`imageID`	`string`	imageID is the ID of the image that triggered a new build.

fromRef

ObjectReference

fromRef contains detailed information about an image that triggered a build.

imageID

string

imageID is the ID of the image that triggered a new build.

API endpoints

The following API endpoints are available:

/apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/clone
- POST: create clone of a Build
/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate
- POST: create instantiate of a BuildConfig

/apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/clone

Table 1. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the BuildRequest

Table 2. Global query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP method: POST
Description: create clone of a Build

Table 3. Body parameters
Parameter	Type	Description
`body`	`BuildRequest` schema

Table 4. HTTP responses
HTTP code	Reponse body
200 - OK	`BuildRequest` schema
201 - Created	`BuildRequest` schema
202 - Accepted	`BuildRequest` schema
401 - Unauthorized	Empty

/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate

Table 5. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the BuildRequest

Table 6. Global query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP method: POST
Description: create instantiate of a BuildConfig

Table 7. Body parameters
Parameter	Type	Description
`body`	`BuildRequest` schema

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`Build` schema
201 - Created	`Build` schema
202 - Accepted	`Build` schema
401 - Unauthorized	Empty