gitlab-org--gitlab-foss/doc/api/deploy_keys.md

81 lines
1.8 KiB
Markdown
Raw Normal View History

2014-05-27 08:12:15 -04:00
# Deploy Keys
2013-06-06 06:19:23 -04:00
2014-04-24 18:48:22 -04:00
## List deploy keys
2013-06-06 06:19:23 -04:00
Get a list of a project's deploy keys.
```
GET /projects/:id/keys
```
Parameters:
2014-04-24 18:48:22 -04:00
- `id` (required) - The ID of the project
2013-06-06 06:19:23 -04:00
```json
[
{
"id": 1,
2014-04-05 02:36:47 -04:00
"title": "Public key",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
"created_at": "2013-10-02T10:12:29Z"
2013-06-06 06:19:23 -04:00
},
{
"id": 3,
2014-04-05 02:36:47 -04:00
"title": "Another Public key",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
"created_at": "2013-10-02T11:12:29Z"
2013-06-06 06:19:23 -04:00
}
]
```
2014-04-24 18:48:22 -04:00
## Single deploy key
2013-06-06 06:19:23 -04:00
Get a single key.
```
GET /projects/:id/keys/:key_id
```
Parameters:
2014-04-24 18:48:22 -04:00
- `id` (required) - The ID of the project
- `key_id` (required) - The ID of the deploy key
2013-06-06 06:19:23 -04:00
```json
{
"id": 1,
2014-04-05 02:36:47 -04:00
"title": "Public key",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
"created_at": "2013-10-02T10:12:29Z"
2013-06-06 06:19:23 -04:00
}
```
2014-04-24 18:48:22 -04:00
## Add deploy key
2013-06-06 06:19:23 -04:00
Creates a new deploy key for a project.
If deploy key already exists in another project - it will be joined to project but only if original one was is accessible by same user
```
POST /projects/:id/keys
```
Parameters:
2014-04-24 18:48:22 -04:00
- `id` (required) - The ID of the project
- `title` (required) - New deploy key's title
- `key` (required) - New deploy key
2013-06-06 06:19:23 -04:00
2014-04-24 18:48:22 -04:00
## Delete deploy key
2013-06-06 06:19:23 -04:00
Delete a deploy key from a project
```
DELETE /projects/:id/keys/:key_id
```
Parameters:
2014-04-24 18:48:22 -04:00
- `id` (required) - The ID of the project
- `key_id` (required) - The ID of the deploy key