1. Documentation
×

v1.Build

Description

Build encapsulates the inputs needed to produce a new deployable image, as well as the status of the execution and a reference to the Pod which executed the build.

Object Schema

Expand or mouse-over a field for more information about it.

apiVersion:

kind:

metadata:

  annotations:

    [string]:

  clusterName:

  creationTimestamp:

  deletionGracePeriodSeconds:

  deletionTimestamp:

  finalizers:

  - [string]:

  generateName:

  generation:

  initializers:

    pending:

    - name:

    result:

      apiVersion:

      code:

      details:

        causes:

        - field:

          message:

          reason:

        group:

        kind:

        name:

        retryAfterSeconds:

        uid:

      kind:

      message:

      metadata:

        resourceVersion:

        selfLink:

      reason:

      status:

  labels:

    [string]:

  name:

  namespace:

  ownerReferences:

  - apiVersion:

    blockOwnerDeletion:

    controller:

    kind:

    name:

    uid:

  resourceVersion:

  selfLink:

  uid:

spec:

  completionDeadlineSeconds:

  nodeSelector:

    [string]:

  output:

    imageLabels:

    - name:

      value:

    pushSecret:

      name:

    to:

      apiVersion:

      fieldPath:

      kind:

      name:

      namespace:

      resourceVersion:

      uid:

  postCommit:

    args:

    - [string]:

    command:

    - [string]:

    script:

  resources:

    limits:

      [string]:

    requests:

      [string]:

  revision:

    git:

      author:

        email:

        name:

      commit:

      committer:

        email:

        name:

      message:

    type:

  serviceAccount:

  source:

    binary:

      asFile:

    contextDir:

    dockerfile:

    git:

      httpProxy:

      httpsProxy:

      noProxy:

      ref:

      uri:

    images:

    - from:

    -   apiVersion:

        fieldPath:

        kind:

        name:

        namespace:

        resourceVersion:

        uid:

      paths:

      - destinationDir:

        sourcePath:

      pullSecret:

        name:

    secrets:

    - destinationDir:

      secret:

        name:

    sourceSecret:

      name:

    type:

  strategy:

    customStrategy:

      buildAPIVersion:

      env:

      - name:

        value:

        valueFrom:

          configMapKeyRef:

            key:

            name:

            optional:

          fieldRef:

            apiVersion:

            fieldPath:

          resourceFieldRef:

            containerName:

            divisor:

            resource:

          secretKeyRef:

            key:

            name:

            optional:

      exposeDockerSocket:

      forcePull:

      from:

        apiVersion:

        fieldPath:

        kind:

        name:

        namespace:

        resourceVersion:

        uid:

      pullSecret:

        name:

      secrets:

      - mountPath:

        secretSource:

          name:

    dockerStrategy:

      buildArgs:

      - name:

        value:

        valueFrom:

          configMapKeyRef:

            key:

            name:

            optional:

          fieldRef:

            apiVersion:

            fieldPath:

          resourceFieldRef:

            containerName:

            divisor:

            resource:

          secretKeyRef:

            key:

            name:

            optional:

      dockerfilePath:

      env:

      - name:

        value:

        valueFrom:

          configMapKeyRef:

            key:

            name:

            optional:

          fieldRef:

            apiVersion:

            fieldPath:

          resourceFieldRef:

            containerName:

            divisor:

            resource:

          secretKeyRef:

            key:

            name:

            optional:

      forcePull:

      from:

        apiVersion:

        fieldPath:

        kind:

        name:

        namespace:

        resourceVersion:

        uid:

      imageOptimizationPolicy:

      noCache:

      pullSecret:

        name:

    jenkinsPipelineStrategy:

      env:

      - name:

        value:

        valueFrom:

          configMapKeyRef:

            key:

            name:

            optional:

          fieldRef:

            apiVersion:

            fieldPath:

          resourceFieldRef:

            containerName:

            divisor:

            resource:

          secretKeyRef:

            key:

            name:

            optional:

      jenkinsfile:

      jenkinsfilePath:

    sourceStrategy:

      env:

      - name:

        value:

        valueFrom:

          configMapKeyRef:

            key:

            name:

            optional:

          fieldRef:

            apiVersion:

            fieldPath:

          resourceFieldRef:

            containerName:

            divisor:

            resource:

          secretKeyRef:

            key:

            name:

            optional:

      forcePull:

      from:

        apiVersion:

        fieldPath:

        kind:

        name:

        namespace:

        resourceVersion:

        uid:

      incremental:

      pullSecret:

        name:

      runtimeArtifacts:

      - destinationDir:

        sourcePath:

      runtimeImage:

        apiVersion:

        fieldPath:

        kind:

        name:

        namespace:

        resourceVersion:

        uid:

      scripts:

    type:

  triggeredBy:

  - bitbucketWebHook:

  -   revision:

  -     git:

  -       author:

  -         email:

            name:

          commit:

          committer:

            email:

            name:

          message:

        type:

      secret:

    genericWebHook:

      revision:

        git:

          author:

            email:

            name:

          commit:

          committer:

            email:

            name:

          message:

        type:

      secret:

    githubWebHook:

      revision:

        git:

          author:

            email:

            name:

          commit:

          committer:

            email:

            name:

          message:

        type:

      secret:

    gitlabWebHook:

      revision:

        git:

          author:

            email:

            name:

          commit:

          committer:

            email:

            name:

          message:

        type:

      secret:

    imageChangeBuild:

      fromRef:

        apiVersion:

        fieldPath:

        kind:

        name:

        namespace:

        resourceVersion:

        uid:

      imageID:

    message:

status:

  cancelled:

  completionTimestamp:

  config:

    apiVersion:

    fieldPath:

    kind:

    name:

    namespace:

    resourceVersion:

    uid:

  duration:

  logSnippet:

  message:

  output:

    to:

      imageDigest:

  outputDockerImageReference:

  phase:

  reason:

  stages:

  - durationMilliseconds:

    name:

    startTime:

    steps:

    - durationMilliseconds:

      name:

      startTime:

  startTimestamp:

Operations

Create a Build

Create a Build

HTTP request

POST /oapi/v1/builds HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "Build",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/oapi/v1/builds <<'EOF'
{
  "kind": "Build",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Build

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.Build

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Create a Build in a namespace

Create a Build

HTTP request

POST /oapi/v1/namespaces/$NAMESPACE/builds HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "Build",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/builds <<'EOF'
{
  "kind": "Build",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Build

Path parameters

Parameter Description

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.Build

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get a Build in a namespace

Read the specified Build

HTTP request

GET /oapi/v1/namespaces/$NAMESPACE/builds/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/builds/$NAME

Path parameters

Parameter Description

name

name of the Build

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

exact

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

export

Should this value be exported. Export strips fields that a user can not specify.

Responses

HTTP Code Schema

200 OK

v1.Build

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get all Builds

List or watch objects of kind Build

HTTP request

GET /oapi/v1/builds HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/oapi/v1/builds

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.BuildList

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Get all Builds in a namespace

List or watch objects of kind Build

HTTP request

GET /oapi/v1/namespaces/$NAMESPACE/builds HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/builds

Path parameters

Parameter Description

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.BuildList

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Watch a Build in a namespace

Watch changes to an object of kind Build

HTTP request

GET /oapi/v1/watch/namespaces/$NAMESPACE/builds/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/oapi/v1/watch/namespaces/$NAMESPACE/builds/$NAME

Path parameters

Parameter Description

name

name of the Build

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

pretty

If 'true', then the output is pretty printed.

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.WatchEvent

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Watch all Builds

Watch individual changes to a list of Build

HTTP request

GET /oapi/v1/watch/builds HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/oapi/v1/watch/builds

Query parameters

Parameter Description

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

pretty

If 'true', then the output is pretty printed.

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.WatchEvent

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Watch all Builds in a namespace

Watch individual changes to a list of Build

HTTP request

GET /oapi/v1/watch/namespaces/$NAMESPACE/builds HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/oapi/v1/watch/namespaces/$NAMESPACE/builds

Path parameters

Parameter Description

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

pretty

If 'true', then the output is pretty printed.

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.WatchEvent

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Update a Build in a namespace

Replace the specified Build

HTTP request

PUT /oapi/v1/namespaces/$NAMESPACE/builds/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "Build",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/builds/$NAME <<'EOF'
{
  "kind": "Build",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Build

Path parameters

Parameter Description

name

name of the Build

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.Build

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Patch a Build in a namespace

Partially update the specified Build

HTTP request

PATCH /oapi/v1/namespaces/$NAMESPACE/builds/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'

{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/builds/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the Build

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.Build

401 Unauthorized

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Delete a Build in a namespace

Delete a Build

HTTP request

DELETE /oapi/v1/namespaces/$NAMESPACE/builds/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  ...
}

Curl request

$ curl -k \
    -X DELETE \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/builds/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.DeleteOptions

Path parameters

Parameter Description

name

name of the Build

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

Responses

HTTP Code Schema

200 OK

v1.Status

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Delete all Builds in a namespace

Delete collection of Build

HTTP request

DELETE /oapi/v1/namespaces/$NAMESPACE/builds HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X DELETE \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/builds

Path parameters

Parameter Description

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.Status

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Create clone of a Build in a namespace

Create clone of a BuildRequest

HTTP request

POST /oapi/v1/namespaces/$NAMESPACE/builds/$NAME/clone HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "BuildRequest",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/builds/$NAME/clone <<'EOF'
{
  "kind": "BuildRequest",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.BuildRequest

Path parameters

Parameter Description

name

name of the BuildRequest

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.BuildRequest

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Update details of a Build in a namespace

Replace details of the specified Build

HTTP request

PUT /oapi/v1/namespaces/$NAMESPACE/builds/$NAME/details HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "Build",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/builds/$NAME/details <<'EOF'
{
  "kind": "Build",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Build

Path parameters

Parameter Description

name

name of the Build

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.Build

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get log of a Build in a namespace

Read log of the specified BuildLog

HTTP request

GET /oapi/v1/namespaces/$NAMESPACE/builds/$NAME/log HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/builds/$NAME/log

Path parameters

Parameter Description

name

name of the BuildLog

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

container

cointainer for which to stream logs. Defaults to only container if there is one container in the pod.

follow

follow if true indicates that the build log should be streamed until the build terminates.

limitBytes

limitBytes, If set, is the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.

nowait

noWait if true causes the call to return immediately even if the build is not available yet. Otherwise the server will wait until the build has started.

pretty

If 'true', then the output is pretty printed.

previous

previous returns previous build logs. Defaults to false.

sinceSeconds

sinceSeconds is a relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.

tailLines

tailLines, If set, is the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime

timestamps

timestamps, If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.

version

version of the build for which to view logs.

Responses

HTTP Code Schema

200 OK

v1.BuildLog

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf