/system/containers/{Container.name}

patch

https://switch-ip/rest/v10.16/system/containers/{Container.name}

Path Params

Container.name

string

required

Reference Resource: Container
Name of the container.

Body Params

allow_unsigned_image

boolean

Indicate if unsigned images are allowed for the container.

container_mounts

string

container_networks

string

enable

boolean

Indicate if container is enabled or disabled.

encrypted_environment_variables

object

Encrypted environment variables to be exposed in container when it is started. Any updates to environment variables will result in the container being restarted.

environment_variables

object

Environment variables to be exposed in container when it is started. Any updates to environment variables will result in the container being restarted.

image_download_vrf

string

Reference Resource: VRF
VRF on which container image should be downloaded.

image_location

string

length ≤ 1024

URL through which the image can be obtained.

name

string

required

length between 1 and 40

Reference Resource: Container
Name of the container.

runtime_constraints

object

Constraints to be applied on the container to avoid impact on the base operation of the switch.

vrfs

array of strings

length ≤ 9223372036854776000

Reference Resource: VRF
Deprecated. Please refer to the Container_Network table to define the network configurations used by the container.

vrfs

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language

Response

Click Try It! to start a request and see the response here!