NAME | TYPE | DESCRIPTION |
---|---|---|
|
| Unique ID for the key. |
|
| ID of the user who created the key. |
|
| ID of the user who owns the key. |
|
| ID of the namespace the invite was sent for. |
|
| The name of the key. |
|
| The key's configuration. |
|
| The RFC3339 formatted string at which the key was created. |
|
| The RFC3339 formatted string at which the key was updated. |
|
| The API URL to the key entity itself. |
|
| The user who authored the key. |
|
| The user who owns the key. |
|
| The namespace who owns the key. |
List the keys for the currently authenticated user. The following parameters can be given as query parameters to the URL. This requires the key:read
permission.
NAME | TYPE | DESCRIPTION |
---|---|---|
|
| Get the keys with names like the given value. |
This will return a list of keys. The list will be paginated to 25 keys per page, and will be ordered lexically. If the crons were paginated, then the pagination information will be in the response header Link
.
Link: <https://api.djinn-ci.com/keys?page=1>; rel="prev",
<https://api.djinn-ci.com/keys?page=3>; rel="next"
This will create a key for the currently authenticated user. This requires the key:write
permission.
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
|
| No | The namespace to store the key in. |
|
| Yes | The name of the key. |
|
| Yes | The private key. |
|
| No | The SSH configuration for the key. |
This will update the given key. This requies the key:write
permission.
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
|
| No | The namespace to store the key in. |
|
| No | The name of the key. |
|
| No | The SSH configuration for the key. |
This will return the updated key.
This will delete the key by the given :id
. This requires the key:delete
permission.
This returns no content in the response body.