summaryrefslogtreecommitdiff
path: root/doc/api/keys.md
diff options
context:
space:
mode:
authorAlex Denisov <1101.debian@gmail.com>2012-09-16 18:21:59 +0300
committerAlex Denisov <1101.debian@gmail.com>2012-09-16 18:21:59 +0300
commit87d40fd276ade536e0b6b3019e52c2e1844e47ea (patch)
treec3c0792a8bd0e12dfe5439a8d595df41f916a5bf /doc/api/keys.md
parentc23eb4082948322a1b690e0850c09bfc8df81589 (diff)
downloadgitlab-ce-87d40fd276ade536e0b6b3019e52c2e1844e47ea.tar.gz
Docs added
Diffstat (limited to 'doc/api/keys.md')
-rw-r--r--doc/api/keys.md79
1 files changed, 79 insertions, 0 deletions
diff --git a/doc/api/keys.md b/doc/api/keys.md
new file mode 100644
index 00000000000..8106eb8abb4
--- /dev/null
+++ b/doc/api/keys.md
@@ -0,0 +1,79 @@
+## List keys
+
+Get a list of currently authenticated user's keys.
+
+```
+GET /keys
+```
+
+```json
+[
+ {
+ "id": 1,
+ "title" : "Public key"
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4
+ 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4
+ soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
+ },
+ {
+ "id": 3,
+ "title" : "Another Public key"
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4
+ 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4
+ soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0="
+ }
+]
+```
+
+## Single key
+
+Get a single key.
+
+```
+GET /keys/:id
+```
+
+Parameters:
+
++ `id` (required) - The ID of a key
+
+```json
+{
+ "id": 1,
+ "title" : "Public key"
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4
+ 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4
+ soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0="
+ }
+```
+## Add key
+
+Create new key owned by currently authenticated user
+
+```
+POST /keys
+```
+
+Parameters:
+
++ `title` (required) - new SSH Key
++ `key` (optional) - new SSH key's title
+
+Will return created key with status `201 Created` on success, or `404 Not
+found` on fail.
+
+## Delete key
+
+Delete key owned by currently authenticated user
+
+```
+DELETE /keys/:id
+```
+
+Parameters:
+
++ `id` (required) - key ID
+
+Will return `200 OK` on success, or `404 Not Found` on fail.
+
+