nova/api-guide/source/request_and_response_formats.rst
Gage Hugo 64cbefbe38 Cleaned up request and response formats page
Cleaned up the request_and_response_formats.rst page by putting the
POST, host, and auth token values into their own block.  Fixed
examples to example since there is currently only one.

Change-Id: I5d5e84c9e92e6770e6d413e90c66e0f4bfec20bf
2016-05-06 12:47:32 -05:00

47 lines
1.2 KiB
ReStructuredText
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

============================
Request and response formats
============================
The OpenStack Compute API only supports JSON request and response
formats, with a mime-type of ``application/json``. As there is only
one supported content type, all content is assumed to be
``application/json`` in both request and response formats.
Request and response example
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The example below shows a request body in JSON format:
**Example: JSON request with headers**
.. code::
POST /v2/010101/servers HTTP/1.1
Host: servers.api.openstack.org
X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb
.. code:: JSON
{
"server": {
"name": "server-test-1",
"imageRef": "b5660a6e-4b46-4be3-9707-6b47221b454f",
"flavorRef": "2",
"max_count": 1,
"min_count": 1,
"networks": [
{
"uuid": "d32019d3-bc6e-4319-9c1d-6722fc136a22"
}
],
"security_groups": [
{
"name": "default"
},
{
"name": "another-secgroup-name"
}
]
}
}