• Buy Now
    • Rackspace Cloud
    • Email & Apps
    • Fanatical Support for AWS
    • Managed Google Cloud Platform
    • Office 365
  • Log In
    • MyRackspace Portal
    • Cloud Control Panel
    • Rackspace Webmail Login
    • Cloud Office Control Panel
  • Rackspace Logo
  • Developer Home
  • Developer Documentation
  • Blogs ▼
    • Technical Blog
    • Rackspace Blog
    • Solve: Thought Leadership
  • Support Documentation

Developer Docs


Let’s Build Something Powerful Together!

End-to-End Multicloud Solutions.   Solving Together.™   Learn more at Rackspace.com

Submit an issue
  • Cloud Images 2.0
  • Getting started
    • Get your credentials
    • Send API requests to Rackspace Cloud Images
      • Convert cURL examples to run on Windows
    • Authenticate to the Rackspace Cloud
      • Send an authentication request
      • Review the authentication response
      • Configure environment variables
    • Concepts
      • Images
        • Standard images
        • Nonstandard images
      • Image entities
      • Image identifiers
      • Image properties
      • Image sharing
        • Sample workflow for image sharing, after image creation
      • Asynchronous tasks
        • High-level process for importing an image
        • High-level process for exporting an image
      • Statuses
        • Image statuses
        • Task statuses
        • Image member statuses
      • HTTP PATCH method
        • Restricted JSON pointers
        • Using the HTTP PATCH method
        • HTTP PATCH add operation
        • HTTP PATCH remove operation
        • HTTP PATCH replace operation
    • Use images
      • Listing images
      • Getting details for an image
      • Updating an image
      • Importing an image by using tasks
      • Exporting an image by using tasks
      • Getting details for a task
    • Share images
      • Creating an image member
      • Listing image members
      • Getting image member details
      • Updating an image member
      • Deleting an image member
  • General API information
    • Service access endpoints
    • Request and response types
      • Media Types
      • JSON Schemas
    • Paginated collections
    • Date and time format
    • Role-based access control (RBAC)
      • Assigning roles to account users
      • Roles available for Cloud Images
      • Multiproduct global roles and permissions
      • Resolving conflicts between RBAC multiproduct and product-specific roles
      • RBAC permissions cross-reference to Cloud Images API operations
  • API reference
    • Images
      • List images
        • Request
        • Response
      • Get image details
        • Request
        • Response
      • Update image
        • Request
        • Response
      • Delete image
        • Request
        • Response
    • Image sharing
      • List image members
        • Request
        • Response
      • Get image member details
        • Request
        • Response
      • Create image member
        • Request
        • Response
      • Delete image member
        • Request
        • Response
      • Update image member
        • Request
        • Response
    • Image tag
      • Add image tag
        • Request
        • Response
      • Delete image tag
        • Request
        • Response
    • Image task
      • List tasks
        • Request
        • Response
      • Get task details
        • Request
        • Response
      • Task to import image
        • Request
        • Response
      • Task to export image
        • Request
        • Response
    • JSON schemas
      • Get images schema
        • Request
        • Response
      • Get image schema
        • Request
        • Response
      • Get image members schema
        • Request
        • Response
      • Get image member schema
        • Request
        • Response
      • Get task schema
        • Request
        • Response
      • Get tasks schema
        • Request
        • Response
  • Glossary
  • Release Notes
    • API v2.0 release, September 9, 2013
      • What's new
      • Resolved issues
      • Known issues
  • Service updates
  • Additional resources
  • Disclaimer

Image tag#

Use image tag API operations to add and remove image tags.

Add image tag#

PUT /images/{image_id}/tags/{tag}

This operation adds the specified tag to the specified image.

Include the tag you want to add in the request URI {tag} path segment of the URI. For example, to tag image e7db3b45-8db7-47ad-8109-3fb55c2c24fd with miracle, use this URI: PUT /v2/images/e7db3b45-8db7-47ad-8109-3fb55c2c24fd/tags/miracle. The request body is ignored.

An image can only be tagged once with a specific string. Multiple attempts to tag an image with the same string will result in a single instance of that string being added to the image's tags list.

This table shows the possible response codes for this operation:

Response Code Name Description
204 Success Request succeeded.
400 Error A general error has occurred.
401 Unauthorized Unauthorized.
403 Forbidden Forbidden.
405 Bad Method Bad method.
413 Over Limit The number of items returned is above the allowed limit.
415 Bad Media Type Bad media type. This may result if the wrong media type is used in the cURL request.
500 API Fault API fault.
503 Service Unavailable The requested service is unavailable.

Request#

This table shows the URI parameters for the request:

Name Type Description
{image_id} UUID Image ID stored through the image API, typically a UUID.
{tag} String Image tag (may be up to 255 characters in length).

This operation does not accept a request body.

Response#

This operation does not return a response body.

Delete image tag#

DELETE /images/{image_id}/tags/{tag}

This operation deletes the specified tag from the specified image.

Include the tag you want to remove in the request URI {tag} path segment of the URI. For example, to remove the image tag miracle from image e7db3b45-8db7-47ad-8109-3fb55c2c24fd, use the following URI in the request: DELETE /v2/images/e7db3b45-8db7-47ad-8109-3fb55c2c24fd/tags/miracle. The request body is ignored.

An image tag can only be removed once. Subsequent attempts to remove the same tag cause an HTTP 404 error.

This table shows the possible response codes for this operation:

Response Code Name Description
204 Delete Successful Delete request succeeded.
400 Error A general error has occurred.
401 Unauthorized Unauthorized.
403 Forbidden Forbidden.
404 Not Found Resource not found.
405 Bad Method Bad method.
413 Over Limit The number of items returned is above the allowed limit.
500 API Fault API fault.
503 Service Unavailable The requested service is unavailable.

Request#

This table shows the URI parameters for the request:

Name Type Description
{image_id} UUID Image ID stored through the image API, typically a UUID.
{tag} String Image tag (may be up to 255 characters in length).

This operation does not accept a request body.

Response#

This operation does not return a response body.

Previous Image sharing
Next Image task
Developer Network
  • Developer Center
  • API Documentation and User Guides
  • SDKs
  • Rackspace How-To
Blogs
  • Technical Blog
  • Rackspace Blog
  • Solve: Thought Leadership
Other Information
  • Customer Stories
  • Events
  • Programs
  • Careers
  • Style Guide for Technical Content
©2020 Rackspace US, Inc.
  • ©2020 Rackspace US, Inc.
  • About Rackspace
  • Privacy Statement
  • Website Terms
  • Trademarks