Vultr DocsLatest Content

How to Update a Repository in Vultr Container Registry

Updated on March 20, 2025

Managing multiple repositories in the Vultr Container Registry with similar names is easier when each has a clear, distinct description. Updating a repository's description adds context to the stored container images, keeps the details up to date, and improves discoverability within container workflows.

Follow this guide to update a repository's description in your container registry on your Vultr account using the Vultr API or CLI.

  • Vultr API
  • Vultr CLI

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

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

  2. Send a GET request to the List Repositories endpoint to list all the available repositories and note the target repository image.

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

  3. Send a PUT request to the Update Repository endpoint to update the target repository's description.

    console 
    $ curl "https://api.vultr.com/v2/registry/{registry-id}/repository/{repository-image}" \
    -X PUT \
    -H "Authorization: Bearer ${VULTR_API_KEY}" \
    -H "Content-Type: application/json" \
    --data '{
        "description" : "{description}"
    }'

  1. List all the available registries in your Vultr account and note the target registry's ID.

    console 
    $ vultr-cli container-registry list

  2. List all the available repositories in your registry and note the target repository image.

    console 
    $ vultr-cli container-registry repository list <registry-id>

  3. Update the target repository's description.

    console 
    $ vultr-cli container-registry repository update <registry-id> --image-name "<repository-image>" --description "<description>"

Comments

No comments yet.