Jump to

• Request
• Response

Retrieve an Execution Environment

get

/api/v2/execution_environments/{id}/

Make GET request to this resource to retrieve a single execution environment record containing the following fields:

• id: Database ID for this execution environment. (integer)
• type: Data type for this execution environment. (choice)
• url: URL for this execution environment. (string)
• related: Data structure with URLs of related resources. (object)
• summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
• created: Timestamp when this execution environment was created. (datetime)
• modified: Timestamp when this execution environment was last modified. (datetime)
• name: Name of this execution environment. (string)
• description: Optional description of this execution environment. (string)
• organization: The organization used to determine access to this execution environment. (id)
• image: The full image location, including the container registry, image name, and version tag. (string)
• managed: (boolean)
• credential: (id)
• pull: Pull image before running? (choice)
  • "": ---------
  • always: Always pull container before running.
  • missing: Only pull the image if not present before running.
  • never: Never pull container before running.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

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"
}

Back to Top