Deploy Keys
List deploy keys
GET /repos/:username/:reponame/keys
Response
Status: 200 OK
[
{
"id": 1,
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDUbmwBOG5vI8qNCztby5LDc9ozwTuw sqf+1fpuHjT9iQ2Lu9nlKHQJcPSgdrYAcc+88K6o74ayhTAjfajKxkIHnbzZ FjidoVZSQDhX5qvl93jvY/Uz390qky0sweW+fspm8pRJL+ofE3QEN5AXAuyc q1tgsRT32XC+Ta82Xyv8b3xW+pWbsZzYCzUsZXDe/xWxg1rndXh2BIrmcYf9 BMiv9ZJIojJXfuLCeRXl550tDzaMFC0rQ/T5pZjs/lQemtg92MnxnEDi5nhu vDwM4Q8eqCTOXc4BCE7iyIHv+B7rx+0x99ytMh5BSIIGyWTfgTot/AjGVm5a RKJSRFgPBm9N comment with whitespace",
"url": "http://localhost:3000/api/v1/repos/unknwon/project_x/keys/1",
"title": "local",
"created_at": "2015-11-18T15:05:43-05:00",
"read_only": true
}
]
{
"id": 1,
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDUbmwBOG5vI8qNCztby5LDc9ozwTuw sqf+1fpuHjT9iQ2Lu9nlKHQJcPSgdrYAcc+88K6o74ayhTAjfajKxkIHnbzZ FjidoVZSQDhX5qvl93jvY/Uz390qky0sweW+fspm8pRJL+ofE3QEN5AXAuyc q1tgsRT32XC+Ta82Xyv8b3xW+pWbsZzYCzUsZXDe/xWxg1rndXh2BIrmcYf9 BMiv9ZJIojJXfuLCeRXl550tDzaMFC0rQ/T5pZjs/lQemtg92MnxnEDi5nhu vDwM4Q8eqCTOXc4BCE7iyIHv+B7rx+0x99ytMh5BSIIGyWTfgTot/AjGVm5a RKJSRFgPBm9N comment with whitespace",
"url": "http://localhost:3000/api/v1/repos/unknwon/project_x/keys/1",
"title": "local",
"created_at": "2015-11-18T15:05:43-05:00",
"read_only": true
}
]
Get a deploy key
GET /repos/:username/:reponame/keys/:id
Response
Status: 200 OK
{
"id": 1,
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDUbmwBOG5vI8qNCztby5LDc9ozwTuw sqf+1fpuHjT9iQ2Lu9nlKHQJcPSgdrYAcc+88K6o74ayhTAjfajKxkIHnbzZ FjidoVZSQDhX5qvl93jvY/Uz390qky0sweW+fspm8pRJL+ofE3QEN5AXAuyc q1tgsRT32XC+Ta82Xyv8b3xW+pWbsZzYCzUsZXDe/xWxg1rndXh2BIrmcYf9 BMiv9ZJIojJXfuLCeRXl550tDzaMFC0rQ/T5pZjs/lQemtg92MnxnEDi5nhu vDwM4Q8eqCTOXc4BCE7iyIHv+B7rx+0x99ytMh5BSIIGyWTfgTot/AjGVm5a RKJSRFgPBm9N comment with whitespace",
"url": "http://localhost:3000/api/v1/repos/unknwon/project_x/keys/1",
"title": "local",
"created_at": "2015-11-18T15:05:43-05:00",
"read_only": true
}
"id": 1,
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDUbmwBOG5vI8qNCztby5LDc9ozwTuw sqf+1fpuHjT9iQ2Lu9nlKHQJcPSgdrYAcc+88K6o74ayhTAjfajKxkIHnbzZ FjidoVZSQDhX5qvl93jvY/Uz390qky0sweW+fspm8pRJL+ofE3QEN5AXAuyc q1tgsRT32XC+Ta82Xyv8b3xW+pWbsZzYCzUsZXDe/xWxg1rndXh2BIrmcYf9 BMiv9ZJIojJXfuLCeRXl550tDzaMFC0rQ/T5pZjs/lQemtg92MnxnEDi5nhu vDwM4Q8eqCTOXc4BCE7iyIHv+B7rx+0x99ytMh5BSIIGyWTfgTot/AjGVm5a RKJSRFgPBm9N comment with whitespace",
"url": "http://localhost:3000/api/v1/repos/unknwon/project_x/keys/1",
"title": "local",
"created_at": "2015-11-18T15:05:43-05:00",
"read_only": true
}
Add a new deploy key
POST /repos/:username/:reponame/keys
Parameters
| Name | Type | Description |
|---|---|---|
| title | string | Required The name of the key |
| key | string | Required The content of the key |
Example
Here's how you can create a deploy key:
{
"title": "unknwon@gogs",
"key": "ssh-rsa AAA...",
}
"title": "unknwon@gogs",
"key": "ssh-rsa AAA...",
}
Response
Status: 201 Created
{
"id": 2,
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDUbmwBOG5vI8qNCztby5LDc9ozwTuw sqf+1fpuHjT9iQ2Lu9nlKHQJcPSgdrYAcc+88K6o74ayhTAjfajKxkIHnbzZ FjidoVZSQDhX5qvl93jvY/Uz390qky0sweW+fspm8pRJL+ofE3QEN5AXAuyc q1tgsRT32XC+Ta82Xyv8b3xW+pWbsZzYCzUsZXDe/xWxg1rndXh2BIrmcYf9 BMiv9ZJIojJXfuLCeRXl550tDzaMFC0rQ/T5pZjs/lQemtg92MnxnEDi5nhu vDwM4Q8eqCTOXc4BCE7iyIHv+B7rx+0x99ytMh5BSIIGyWTfgTot/AjGVm5a RKJSRFgPBm9N comment with whitespace",
"url": "http://localhost:3000/api/v1/repos/unknwon/project_x/keys/2",
"title": "local2",
"created_at": "2015-11-18T21:18:55.292816433-05:00",
"read_only": true
}
"id": 2,
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDUbmwBOG5vI8qNCztby5LDc9ozwTuw sqf+1fpuHjT9iQ2Lu9nlKHQJcPSgdrYAcc+88K6o74ayhTAjfajKxkIHnbzZ FjidoVZSQDhX5qvl93jvY/Uz390qky0sweW+fspm8pRJL+ofE3QEN5AXAuyc q1tgsRT32XC+Ta82Xyv8b3xW+pWbsZzYCzUsZXDe/xWxg1rndXh2BIrmcYf9 BMiv9ZJIojJXfuLCeRXl550tDzaMFC0rQ/T5pZjs/lQemtg92MnxnEDi5nhu vDwM4Q8eqCTOXc4BCE7iyIHv+B7rx+0x99ytMh5BSIIGyWTfgTot/AjGVm5a RKJSRFgPBm9N comment with whitespace",
"url": "http://localhost:3000/api/v1/repos/unknwon/project_x/keys/2",
"title": "local2",
"created_at": "2015-11-18T21:18:55.292816433-05:00",
"read_only": true
}
Remove a deploy key
DELETE /repos/:username/:reponame/keys/:id
Response
Status: 204 No Content