app.image.pull

Pull a docker image.

This method is a job.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: image_pull

image_pull

Type: object

AppImagePullArgs parameters.

No Additional Properties

auth_config

Default: null

Authentication configuration for private registries or null for public images.

Any of

• AppImageAuthConfig
• Option 2

AppImageAuthConfig

Type: object
No Additional Properties

username Required

Username

Type: string

Username for container registry authentication.

password Required

Password

Type: string

Password or access token for container registry authentication.

registry_uri

Registry Uri

Default: null

Container registry URI or null to use default registry.

Any of

• Option 1
• Option 2

Type: string

Type: null

Type: null

image Required

Image

Type: string

Container image reference to pull (registry/repository:tag).

Must be at least 1 characters long

Return value

Result

Type: null

Returns null when the image is successfully pulled.

Required roles: APPS_WRITE