156 lines
3.0 KiB
ReStructuredText
156 lines
3.0 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=====================
|
|
Keypairs (keypairs)
|
|
=====================
|
|
|
|
Generates, imports, and deletes SSH keys.
|
|
|
|
List Keypairs
|
|
=============
|
|
|
|
.. rest_method:: GET /keypairs
|
|
|
|
Lists keypairs that are associated with the account.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- user_id: keypair_user
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- created_at: created_at
|
|
- updated_at: created_at
|
|
- keypairs: keypairs
|
|
- user_id: keypair_userid_in
|
|
- name: keypair_name
|
|
- public_key: keypair_public_key
|
|
- fingerprint: keypair_fingerprint
|
|
- type: keypair_type
|
|
- links: links
|
|
|
|
**Example List Keypairs: JSON response**
|
|
|
|
.. literalinclude:: samples/keypairs/keypairs-list-resp.json
|
|
:language: javascript
|
|
|
|
Create Or Import Keypair
|
|
========================
|
|
|
|
.. rest_method:: POST /keypairs
|
|
|
|
Generates or imports a keypair.
|
|
|
|
Normal response codes: 200, 201
|
|
|
|
.. note::
|
|
|
|
The success status code was changed from 200 to 201 in version 2.2
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403), conflict(409)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- name: keypair_name
|
|
- public_key: keypair_public_key_in
|
|
- type: keypair_type_in
|
|
- user_id: keypair_userid_in
|
|
|
|
**Example Create Or Import Keypair: JSON request**
|
|
|
|
.. literalinclude:: samples/keypairs/keypairs-import-post-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- created_at: created_at
|
|
- updated_at: created_at
|
|
- name: keypair_name
|
|
- public_key: keypair_public_key
|
|
- fingerprint: keypair_fingerprint
|
|
- user_id: keypair_userid
|
|
- private_key: keypair_private_key
|
|
- type: keypair_type
|
|
|
|
**Example Create Or Import Keypair: JSON response**
|
|
|
|
.. literalinclude:: samples/keypairs/keypairs-import-post-resp.json
|
|
:language: javascript
|
|
|
|
Show Keypair Details
|
|
====================
|
|
|
|
.. rest_method:: GET /keypairs/{keypair_name}
|
|
|
|
Shows details for a keypair that is associated with the account.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- keypair_name: keypair_name_path
|
|
- user_id: keypair_user
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- created_at: created_at
|
|
- updated_at: created_at
|
|
- fingerprint: keypair_fingerprint
|
|
- name: keypair_name
|
|
- public_key: keypair_public_key
|
|
- user_id: keypair_userid
|
|
- type: keypair_type
|
|
|
|
**Example Show Keypair Details: JSON response**
|
|
|
|
.. literalinclude:: samples/keypairs/keypairs-get-resp.json
|
|
:language: javascript
|
|
|
|
Delete Keypair
|
|
==============
|
|
|
|
.. rest_method:: DELETE /keypairs/{keypair_name}
|
|
|
|
Deletes a keypair.
|
|
|
|
Normal response codes: 204
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- keypair_name: keypair_name_path
|
|
- user_id: keypair_user
|
|
|
|
Response
|
|
--------
|
|
|
|
There is no body content for the response of a successful DELETE query
|