Oracle Linux Automation Manager CLI and API Reference Guide

Update an Execution Environment

patch

/api/v2/execution_environments/{id}/

Make a PUT or PATCH request to this resource to update this execution environment. The following fields may be modified:

name: Name of this execution environment. (string, required)
description: Optional description of this execution environment. (string, default="")
organization: The organization used to determine access to this execution environment. (id, default=``)
image: The full image location, including the container registry, image name, and version tag. (string, required)
credential: (id, default=``)
pull: Pull image before running? (choice)
- "": --------- (default)
- always: Always pull container before running.
- missing: Only pull the image if not present before running.
- never: Never pull container before running.

For a PATCH request, include only the fields that are being modified.

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Root Schema : ExecutionEnvironment

Type: object

Show Source

created: string

Title: Created

Read Only: true
credential: integer

Title: Credential
description: string

Title: Description
id: integer

Title: ID

Read Only: true
image(required): string

Title: Image location

Minimum Length: 1

Maximum Length: 1024

The full image location, including the container registry, image name, and version tag.
managed: string

Title: Managed

Read Only: true
modified: string

Title: Modified

Read Only: true
name(required): string

Title: Name

Minimum Length: 1

Maximum Length: 512
organization: integer

Title: Organization

The organization used to determine access to this execution environment.
pull: string

Title: Pull

Allowed Values: [ "always", "missing", "never" ]

Pull image before running?
related: string

Title: Related

Read Only: true
summary_fields: string

Title: Summary fields

Read Only: true
type: string

Title: Type

Read Only: true
url: string

Title: Url

Read Only: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential":{
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "image":{
            "description":"The full image location, including the container registry, image name, and version tag.",
            "maxLength":"1024",
            "minLength":"1",
            "title":"Image location",
            "type":"string",
            "x-nullable":true
        },
        "managed":{
            "readOnly":true,
            "title":"Managed",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"The organization used to determine access to this execution environment.",
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "pull":{
            "description":"Pull image before running?",
            "enum":[
                "always",
                "missing",
                "never"
            ],
            "title":"Pull",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name",
        "image"
    ],
    "type":"object"
}

Response

Supported Media Types

application/json

200 Response

Root Schema : ExecutionEnvironment

Type: object

Show Source

created: string

Title: Created

Read Only: true
credential: integer

Title: Credential
description: string

Title: Description
id: integer

Title: ID

Read Only: true
image(required): string

Title: Image location

Minimum Length: 1

Maximum Length: 1024

The full image location, including the container registry, image name, and version tag.
managed: string

Title: Managed

Read Only: true
modified: string

Title: Modified

Read Only: true
name(required): string

Title: Name

Minimum Length: 1

Maximum Length: 512
organization: integer

Title: Organization

The organization used to determine access to this execution environment.
pull: string

Title: Pull

Allowed Values: [ "always", "missing", "never" ]

Pull image before running?
related: string

Title: Related

Read Only: true
summary_fields: string

Title: Summary fields

Read Only: true
type: string

Title: Type

Read Only: true
url: string

Title: Url

Read Only: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential":{
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "image":{
            "description":"The full image location, including the container registry, image name, and version tag.",
            "maxLength":"1024",
            "minLength":"1",
            "title":"Image location",
            "type":"string",
            "x-nullable":true
        },
        "managed":{
            "readOnly":true,
            "title":"Managed",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"The organization used to determine access to this execution environment.",
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "pull":{
            "description":"Pull image before running?",
            "enum":[
                "always",
                "missing",
                "never"
            ],
            "title":"Pull",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name",
        "image"
    ],
    "type":"object"
}