IRC on Freenode #rackspace
  • Sign Up
  • Log In
    • MyRackspace Portal
    • Cloud Control Panel
    • Rackspace Webmail Login
    • Email Admin Login
  • Rackspace Logo
  • Developer Home
  • Documentation & SDKs
  • Blog
SDK Quickstarts
  • Gophercloud Go
  • JClouds Java
  • OpenStack.NET.NET
  • pkgcloud Node.js
  • php-opencloud PHP
  • pyrax Python
  • fog Ruby
Cloud User Guides
  • Core Infrastructure
  • Cloud Servers
  • Cloud Images
  • Orchestration
Developer Community
  • Developer Blog
  • Knowledge Center
  • Developer Forum
  • Outreach & Events
Rackspace Cloud
  • Auto Scale
  • CDN
  • Cloud Block Storage
  • Cloud Databases
  • Cloud DNS
  • Cloud Files
  • Identity
  • Cloud Images
  • Cloud Load Balancers
  • Cloud Monitoring
  • Cloud Networks
  • Cloud Queues
  • Cloud Servers
  • Orchestration
Other Products
  • Airbrake
  • Mailgun
  • ObjectRocket
  • RedisToGo
Developer Community
  • Developer Blog
  • Knowledge Center
  • Developer Forum
  • Outreach & Events

Rackspace Developer Docs


Let’s Build Something Powerful Together!

Submit an issue
  • Rackspace Style Guide
  • Quickstart
  • Writing guidelines
    • Use active voice
    • Use present tense
    • Write to the user by using second person and imperative mood
    • Write clear and concise sentences and paragraphs
      • Use a consistent sentence structure
      • Restrict sentence length
      • Use only, but all of, the necessary words
      • Create short paragraphs
    • Use effective verbs
      • Use action-oriented verbs
      • Avoid nouns built from verbs
      • Use the simplest tense
      • Use helping verbs accurately
      • Use single-word verbs
      • Don't use verbs as nouns or adjectives
      • Don't use nonverbs as verbs
      • Use transitive verbs transitively, not intransitively
      • Don't humanize inanimate objects
    • Clarify gerunds and participles
    • Use that, which, and such as correctly
    • Use pronouns carefully
      • It
      • This
      • There
      • That
    • Use gender-neutral pronouns
    • Use positive statements
    • Use correct punctuation
    • Use interjections with care
  • Style guidelines
    • Abbreviations
      • Abbreviations of byte and bit
      • Common abbreviations
    • Capitalization
      • Capitalize proper nouns and adjectives
      • Capitalize most abbreviations
      • Capitalization in job titles
      • Capitalize team names
      • Capitalize UI labels as shown on the UI
      • Capitalize the names of product components as appropriate
      • Don't capitalize common nouns
      • Don't use all capitals for emphasis
      • Reference to other capitalization guidelines
    • Citations
    • Cloud account information
    • Code examples
      • Create a VM running a Docker host
      • Run the application
      • Remove the containers already using the port
      • Troubleshooting
    • Contractions
    • Copyrights
    • Dates
    • Email addresses
    • File types
    • Glossaries
      • Glossary terms
      • Glossary definitions
      • Cross-references to glossary terms
      • Guidelines for a comprehensive glossary
    • IP addresses
    • Keyboard keys
    • Links and cross-references
    • Lists
      • Introductory text
      • List items
    • Messages
    • Names
    • Notes and other notation types
    • Numbers
      • Numbers versus words
      • Commas in numbers
      • Ranges of numbers
      • Unspecified, generic, and unknown numbers
    • Parameters
    • Placeholder (variable) text
    • Plurals
    • Product names and version numbers
    • Punctuation
      • Ampersands
      • Colons
      • Commas
      • Dashes
      • Ellipses
      • Exclamation points
      • Hyphens
      • Parentheses
      • Periods
      • Quotation marks
      • Semicolons
      • Slashes
    • Symbols
    • Tables
      • Introductory text for tables
      • Table titles
      • Column headers
      • Table text
      • Table footnotes
      • Attribute or parameter tables in API documents
      • Examples
    • Tasks
      • Task titles
      • Task introductions
      • Prerequisites
      • Procedures
      • Steps
      • Results, verification, examples, and troubleshooting
      • Direction to the next action
      • Related topics
    • Telephone numbers
    • Text formatting
    • Time
      • 24-hour clock
      • 12-hour clock
    • Titles and headings
      • Capitalization
      • Style and structure
      • Text following titles and headings
      • Tables of contents
    • Trademarks
      • Examples of Rackspace trademarks
      • Examples of third-party trademarks
      • Links to company trademark pages
      • Trademark usage guidelines
    • URLs and domain names
  • Markup guidelines
    • ReStructured Text (RST)
    • MarkDown (MD)
  • Terminology guidelines
    • General terminology guidelines
      • Use consistent terminology
      • Use short, familiar words and phrases
      • Use consistent references to time, space, and versions
      • Avoid obscure non-English words and abbreviations
    • Terminology for a global audience
      • Don't use idioms or colloquialisms
      • Avoid metaphorical terms
      • Don't use humor
      • Use jargon carefully
      • Use culture-neutral language and examples
      • Use culture-neutral graphics
    • Alphabetical list of terms
    • Concise terms
    • Third-party names and trademarks
  • Screenshot and diagram guidelines
    • Screenshot guidelines and process
      • When to use screenshots
      • Screenshot alternatives
      • Before you create a screenshot
      • Screenshots in procedures
      • Screenshot checklist
    • Diagram guidelines
      • When to use diagrams
      • Before you create a diagram
      • Diagram checklist
  • How-To article guidelines
    • Use sentence-style capitalization for titles and headings
    • Use active voice
    • Use present tense
    • Write to the user by using second person and imperative mood
    • Write clear and consistent step text
    • Use consistent text formatting
    • Clarify pronouns such as it, this, there, and that
    • Clarify gerunds and participles
    • Write clear and consistent code examples
    • Use consistent terminology
    • When and when not to suggest contacting Support
  • Blog guidelines
    • Things to consider before writing a blog
    • Blog writing suggestions
    • Voice and tone
    • Write to the user by using second person and imperative mood
  • Error message guidelines
    • General guidelines
    • Message guidelines and examples
    • Message types
  • Release notes guidelines
    • Structure
    • Formatting
    • Wording
    • Editing existing release notes
  • User interface guidelines
  • Style guide revision history
    • February 22, 2019
    • February 6, 2019
    • January 21, 2019
    • January 4, 2019
    • November 5, 2018
    • November 2, 2018
    • September 25, 2018 (End of Q3 release)
    • June 29, 2018 (End of Q2 release)
    • May 8, 2018
    • April 16, 2018
    • June 19, 2017
    • April 28, 2017
    • November 10, 2016
    • July 27, 2016

Cloud account information#

In examples of API authentication requests, and other examples where we are teaching the use of the API and expect that users might copy the code and use it, use variables or the following standard values for account numbers, usernames, passwords, API keys, and so on. Format the variables by using camelCase and italics, and also use bold within the examples.

Information Use Don't use
Account or tenant ID

yourAccountId

yourTenantId

$account

$tenant

658405
Username

yourUsername

$username

robb4554
Password

yourPassword

$password

J$12345*
API key

yourApiKey

$apikey

of938go4915e114f7ff5448910fee68c
Authentication token

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

$token

2e356864f39831523c184to646b1997b

In example API operation requests and responses, in which we want users to see actual values from the system, use "real-looking" values that are nevertheless obviously made up, such the following one for X-Auth-Token:

abcdef123ghi4j5k67m8910n12op3qrs

Warning

Don't include or show actual writer or user account credentials in code examples or screenshots.

Previous Citations
Next Code examples
Docs
  • Style Guide for Technical Content
  • Cloud Backup
  • Cloud Block Storage
  • Cloud Databases
  • Cloud DNS
  • Cloud Files
  • Identity
  • Cloud Images
  • Cloud Load Balancers
  • Cloud Monitoring
  • Cloud Orchestration
  • Cloud Networks
  • Cloud Queues
  • Cloud Servers
  • Rackspace Auto Scale
  • Rackspace CDN
Sdks
  • Go
  • Java
  • .Net
  • Node
  • PHP
  • Python
  • Ruby
Partner Tools
  • Airbrake
  • Mailgun
  • ObjectRocket
  • RedisToGo
Blog
  • Developer Blog
©2018 Rackspace US, Inc.
  • ©2018 Rackspace US, Inc.
  • About Rackspace
  • Investors
  • Careers
  • Privacy Statement
  • Website Terms
  • Trademarks