How to Retrieve a Robot Account Details from Vultr Container Registry

A robot account in the Vultr Container Registry is an automatically generated account designed for automated interactions with repositories. These accounts operate within a defined namespace and come with pre-configured permissions, such as pulling images from repositories. They are commonly used in CI/CD pipelines, automation scripts, and containerized deployments, ensuring secure, non-interactive access without exposing user credentials.

Follow this guide to retrieve robot account details from your container registry on your Vultr account using the Vultr API.

1. Send a GET request to the List Container Registries endpoint and note the target registry's ID.

   console Copy

   $ curl "https://api.vultr.com/v2/registries" \
       -X GET \
       -H "Authorization: Bearer ${VULTR_API_KEY}"
   

2. Send a GET request to the List Robots endpoint to list all the available robots and note the target robot's name.

   console Copy

   $ curl "https://api.vultr.com/v2/registry/{registry-id}/robots" \
       -X GET \
       -H "Authorization: Bearer ${VULTR_API_KEY}"
   

   Note

   Robot account names contain special characters like $ and +, which must be URL-encoded before making API requests to prevent errors. You can either manually replace $ with %24 and + with %2B in the endpoint or export the robot name as a variable, avoiding the need for manual encoding.

3. Send a GET request to the Read Robot endpoint to retrieve the target robot details.

   console Copy

   $ curl "https://api.vultr.com/v2/registry/{registry-id}/robot/{robot-name}" \
       -X GET \
       -H "Authorization: Bearer ${VULTR_API_KEY}"