Pull Docker images on a target

POST api/v2/jobs/rvc '{"method":"docker.pull","params":{"images":["<image>"]},"hostnames":["<node_hostname>"]}'

Starts a SC//Reliant™ Virtual Controller (RVC) job to pull a list of Docker images on one or more targets. RVC uses the /opt/reliant/bin/docker-image.sh script on the node if it is available, and otherwise falls back to the standard docker pull command. Images that are already present and valid are not downloaded again. The available targets are a node, node group, or saved filter. The response will indicate that the RVC job is created and is scheduled to run. You can use the job ID from the response to retrieve the job status and the payload.

Note: This method runs in the background. The job finishes as soon as the operation starts, and its payload only confirms that the operation was started. To confirm that the operation completed, run docker.images after the operation finishes, or check the RVC log on the node. For more information, see Troubleshooting RVC jobs.

In order to perform this action, the following conditions must be met:

Must have the Remote Job Execution feature turned on at the site level.
The user must have the following capabilities:
- Create and Update a RVC job
- Call Docker state altering methods

Request syntax

post api/v2/jobs/rvc '{"method":"docker.pull","params":{"images":["<image>"]},"hostnames":["<node_hostname>"]}'

Request parameters

The request accepts the following data in JSON format.

Parameter	Type	Description	Required
`method`	String	The RVC action to start. This value is specified as a combination of the RVC module and method. For example, to pull Docker images you would specify the `docker` module and the `pull` method combined as `docker.pull`.	Yes
`params`	Object	The parameters for the method. For the supported parameters, see Method parameters.	Yes
`hostnames`	String array	The list of node hostnames on which to run the RVC job.	Dependent. Only if no node group or saved filter is provided.
`node_group_name`	String	The name of the node group on which to run the RVC job. The RVC job will run on all nodes that are members of the node group.	Dependent. Only if no hostnames or saved filter is provided.
`node_group_id`	Integer	The ID of the node group on which to run the RVC job. The RVC job will run on all nodes that are members of the node group.	Dependent. Only if no hostnames or saved filter is provided.
`saved_filter_name`	String	The name of the saved filter on which to run the RVC job. The RVC job will run on all nodes that match the saved filter.	Dependent. Only if no hostnames or node group is provided.
`saved_filter_id`	Integer	The ID of the saved filter on which to run the RVC job. The RVC job will run on all nodes that match the saved filter.	Dependent. Only if no hostnames or node group is provided.

Method parameters

The params object accepts the following parameters.

Parameter	Type	Description	Required	Default value
`images`	String array	The Docker images to pull.	Yes	-
`strict`	Boolean	If `true`, only the `docker-image.sh` script is used, and the operation fails if the script is not available.	No	`false`
`verbose`	Boolean	Enables verbose logging output.	No	`true`
`prune`	Boolean	If `true`, removes Docker images that are not in `images` after pulling.	No	`false`
`retries`	Integer	The number of pull attempts if a download fails.	No	`3`
`max_wait`	Integer	The maximum random wait time, in seconds, before the pull starts.	No	`0`
`sleep_between_pulls`	Integer	The wait time, in seconds, between pulling each image.	No	`10`
`stage_images`	Boolean	Whether to download (stage) the images in the `images` list. The script checks each image, skips images that are already present and valid, and pulls the rest, retrying up to `retries` times. If `false`, no images are pulled, which is useful with `prune` to only remove images that are not in the list. Only applies when the `docker-image.sh` script is used.	No	`true`
`notify_uri`	String	A URI to which RVC sends progress messages for the operation, including a final message with its exit code.	No	`null`

Response syntax

When the hostnames request parameter is used, the following response syntax is received.

{
    "id": integer,
    "type": "RVC3",
    "status": "string",
    "message": "string",
    "trigged_by": "string",
    "parameters": {
        "method": "docker.pull",
        "params": {
            "images": [
                "<image>"
            ]
        },
        "update_rpm": boolean,
        "hostnames": [
            "string"
        ]
    },
    "time_started": "timestamp"
}

Response parameters

If the action is successful, an HTTP 200 response is returned. The following data is returned in JSON format.

Field	Type	Description
`id`	Integer	The ID of the RVC job.
`type`	String	The type of RVC job. For RVC jobs, it is `RVC3`.
`status`	String	The status of the job.
`message`	String	This field is reserved for internal use.
`trigged_by`	String	The username of the person who initiated the job.
`parameters`	Object	The request parameters indicating the method, method parameters, and the hostnames, node groups, or saved filters the RVC job ran on.
`time_started`	Timestamp	The timestamp indicating when the job started. The timestamp is given in ISO 8601 UTC datetime format.

Errors

For a list of potential errors, see Troubleshooting RVC jobs and Common errors.

Examples

Example 1: Pull a Docker image on a node.

This example pulls the image nginx:latest on the node with hostname sit0001red0.

ruby api.rb <customer_code> POST api/v2/jobs/rvc '{"method":"docker.pull","params":{"images":["nginx:latest"]},"hostnames":["sit0001red0"]}'

Response

{
  "id": 1781992,
  "type": "RVC3",
  "status": "pending",
  "message": null,
  "trigged_by": "test.user",
  "parameters": {
    "method": "docker.pull",
    "params": {
      "images": [
        "nginx:latest"
      ]
    },
    "update_rpm": true,
    "hostnames": [
      "sit0001red0"
    ]
  },
  "time_started": "2026-10-11T21:24:01Z"
}

Example 2: Retrieving the payload from the RVC job.

This example retrieves the payload from RVC job ID 1781992.

ruby api.rb <customer_code> GET "api/jobs/1781992?include_payload=true"

Response

{
  "id": 1781992,
  "type": "RVC3",
  "status": "finished",
  "message": null,
  "trigged_by": "test.user",
  "success_nodes_count": 1,
  "failed_nodes_count": 0,
  "total_nodes_count": 1,
  "parameters": {
    "method": "docker.pull",
    "params": {
      "images": [
        "nginx:latest"
      ]
    },
    "hostnames": [
      "sit0001red0"
    ],
    "update_rpm": true
  },
  "time_started": "2026-10-11T21:24:01Z",
  "time_finished": "2026-10-11T21:24:01Z",
  "payload": {
    "sit0001red0": [
      {
        "result": "Pulling docker images...",
        "timestamp": 1791753841
      }
    ]
  }
}