nova/api-ref/source/os-certificates.inc
Sean Dague c43e8bd9fa api-ref: add note about os-certificates API
The os-certificates API is weird, and only wasn't removed during the
ec2 drop because we exposed it in the osapi. It will be dropped in the
future, and we should tell people to not use it starting now.

Change-Id: I95f8a9620f7eb865298b656477f77257de91b2cc
2016-07-01 12:53:28 +00:00

70 lines
1.5 KiB
ReStructuredText

.. -*- rst -*-
=====================================
Root certificates (os-certificates)
=====================================
Creates and shows details for a root certificate.
.. note::
This API existed solely because of the need to build euca bundles
when Nova had an in tree EC2 API. It no longer interacts with any
parts of the system besides it's own certificate daemon. It should
be considered vestigial, and will likely be deprecated and removed
in the near future.
Create Root Certificate
=======================
.. rest_method:: POST /os-certificates
Creates a root certificate.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
Response
--------
.. rest_parameters:: parameters.yaml
- certificate: certificate
- data: data
- private_key: private_key
|
**Example Create Root Certificate**
.. literalinclude:: ../../doc/api_samples/os-certificates/certificate-create-resp.json
:language: javascript
Show Root Certificate Details
=============================
.. rest_method:: GET /os-certificates/root
Shows details for a root certificate.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501)
Response
--------
.. rest_parameters:: parameters.yaml
- certificate: certificate
- data: data
- private_key: private_key
|
**Example Show Root Certificate Details**
.. literalinclude:: ../../doc/api_samples/os-certificates/certificate-get-root-resp.json
:language: javascript