Soon, all Red Hat OpenShift documentation will only be available on docs.redhat.com, the official location of all Red Hat product documentation. Get familiar with the updated experience today!
  1. Documentation
×

v1.ProcessedTemplate

Description

Template contains the inputs needed to produce a Config.

Object Schema

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

apiVersion:

kind:

labels:

  [string]:

message:

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:

objects:

- Raw:

parameters:

- description:

  displayName:

  from:

  generate:

  name:

  required:

  value:

Operations

Create a ProcessedTemplate

Create a Template

HTTP request

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

{
  "kind": "ProcessedTemplate",
  "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/processedtemplates <<'EOF'
{
  "kind": "ProcessedTemplate",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Template

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v1.Template

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Create a ProcessedTemplate in a namespace

Create a Template

HTTP request

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

{
  "kind": "ProcessedTemplate",
  "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/processedtemplates <<'EOF'
{
  "kind": "ProcessedTemplate",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Template

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.Template

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf