GIgitlab
deploy_resources

Create a deploy key

Creates a deploy key for the GitLab instance. Requires administrator access.

post/api/v4/deploy_keys

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Request body

keystring required

New deploy key

titlestring required

New deploy key's title

expires_atstring date-time

The expiration date of the SSH key in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)

Response

Create a deploy key

idinteger required
titlestring required
created_atstring date-time required
expires_atstring date-time required
last_used_atstring date-time required
keystring required
usage_typestring required
fingerprintstring
fingerprint_sha256string required

Example response

{
  "id": 1,
  "title": "Sample key 25",
  "created_at": "2015-09-03T07:24:44.627Z",
  "expires_at": "2020-09-03T07:24:44.627Z",
  "last_used_at": "2020-09-03T07:24:44.627Z",
  "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDNJAkI3Wdf0r13c8a5pEExB2YowPWCSVzfZV22pNBc1CuEbyYLHpUyaD0GwpGvFdx2aP7lMEk35k6Rz3ccBF6jRaVJyhsn5VNnW92PMpBJ/P1UebhXwsFHdQf5rTt082cSxWuk61kGWRQtk4ozt/J2DF/dIUVaLvc+z4HomT41fQ==",
  "usage_type": "auth",
  "fingerprint": "4a:9d:64:15:ed:3a:e6:07:6e:89:36:b3:3b:03:05:d9",
  "fingerprint_sha256": "Jrs3LD1Ji30xNLtTVf9NDCj7kkBgPBb2pjvTZ3HfIgU",
  "projects_with_write_access": {
    "id": 1,
    "description": "desc",
    "name": "project1",
    "name_with_namespace": "John Doe / project1",
    "path": "project1",
    "path_with_namespace": "namespace1/project1",
    "created_at": "2020-05-07T04:27:17.016Z"
  },
  "projects_with_readonly_access": {
    "id": 1,
    "description": "desc",
    "name": "project1",
    "name_with_namespace": "John Doe / project1",
    "path": "project1",
    "path_with_namespace": "namespace1/project1",
    "created_at": "2020-05-07T04:27:17.016Z"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.