# app.image.pull

image is the name of the image to pull. Format for the name is “registry/repo/image:v1.2.3” where registry may be omitted and it will default to docker registry in this case. It can or cannot contain the tag - this will be passed as is to docker so this should be analogous to what docker pull expects.

auth_config should be specified if image to be retrieved is under a private repository.

This method is a job.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: image_pull

#### image_pull

Type: object

AppImagePullArgs parameters.

No Additional Properties

##

Default: null

Authentication configuration for private registries or `null` for public images.

## Any of

#### AppImageAuthConfig

Type: object
No Additional Properties

##

#### Username

Type: string

Username for container registry authentication.

##

#### Password

Type: string

Password or access token for container registry authentication.

##

#### Registry Uri

Default: null

Container registry URI or `null` to use default registry.

## Any of

Type: string
Type: null
Type: null

##

#### Image

Type: string

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

Must be at least `1` characters long

##

#### Result

Type: null

Returns `null` when the image is successfully pulled.

Required roles: APPS_WRITE