diff options
| author | Matt Humphrey <matt@tomatto.co.uk> | 2013-03-05 21:23:29 +0000 |
|---|---|---|
| committer | Matt Humphrey <matt@tomatto.co.uk> | 2013-03-05 21:23:29 +0000 |
| commit | f411772e3395f569da893dd1fc0fd666dcbb5caa (patch) | |
| tree | 5d1fd661d562208bf17d20631224a7125ec37aba /doc | |
| parent | 6beae84ea37e03e68affd2b69fba25f45a4e5386 (diff) | |
| download | gitlab-ce-f411772e3395f569da893dd1fc0fd666dcbb5caa.tar.gz | |
Project deploy keys API
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/projects.md | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md index ed9690f09a2..e599ed49c43 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -274,3 +274,82 @@ Parameters: + `hook_id` (required) - The ID of hook to delete Will return status `200 OK` on success, or `404 Not found` on fail. + + +## List deploy keys + +Get a list of a project's deploy keys. + +``` +GET /projects/:id/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 deploy key + +Get a single key. + +``` +GET /projects/:id/keys/:key_id +``` + +Parameters: + ++ `id` (required) - The ID of an deploy key + +```json +{ + "id": 1, + "title" : "Public key" + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 + 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 + soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=" +} +``` +## Add deploy key + +Create new deploy key for a project + +``` +POST /projects/:id/keys +``` + +Parameters: + ++ `title` (required) - new deploy key's title ++ `key` (required) - new deploy key + +Will return created key with status `201 Created` on success, or `404 Not +found` on fail. + +## Delete deploy key + +Delete a deploy key from a project + +``` +DELETE /projects/:id/keys/:key_id +``` + +Parameters: + ++ `id` (required) - Deploy key ID + +Will return `200 OK` on success, or `404 Not Found` on fail.
\ No newline at end of file |