全てのデプロイキーをリストアップ
プロジェクトのデプロイキーのリスト
ユーザーのプロジェクトデプロイキーのリスト
デプロイキーの取得
デプロイキーの追加
デプロイキーの更新
デプロイキーの削除
デプロイキーを有効にします。
複数のプロジェクトへのデプロイキーの追加

デプロイキーAPI

デプロイ鍵 API は、公開鍵のフィンガープリントを以下のフィールドでレスポンスとして返します：

fingerprint (MD5 ハッシュ)。FIPS 対応システムでは使用できません。
fingerprint_sha256 (SHA256 ハッシュ)。GitLab 15.2で導入。

全てのデプロイキーをリストアップ

projects_with_readonly_access GitLab 16.0で導入。

GitLabインスタンスの全プロジェクトにわたる全デプロイキーのリストを取得します。このエンドポイントは管理者アクセスが必要で、GitLab.comでは利用できません。

GET /deploy_keys

サポートされる属性：

属性	種類	必須	説明
`public`	boolean	{点線円｝いいえ	公開されているデプロイ鍵のみを返します。デフォルトは`false` です。

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/deploy_keys?public=true"

応答例

[
  {
    "id": 1,
    "title": "Public key",
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDNJAkI3Wdf0r13c8a5pEExB2YowPWCSVzfZV22pNBc1CuEbyYLHpUyaD0GwpGvFdx2aP7lMEk35k6Rz3ccBF6jRaVJyhsn5VNnW92PMpBJ/P1UebhXwsFHdQf5rTt082cSxWuk61kGWRQtk4ozt/J2DF/dIUVaLvc+z4HomT41fQ==",
    "fingerprint": "4a:9d:64:15:ed:3a:e6:07:6e:89:36:b3:3b:03:05:d9",
    "fingerprint_sha256": "SHA256:Jrs3LD1Ji30xNLtTVf9NDCj7kkBgPBb2pjvTZ3HfIgU",
    "created_at": "2013-10-02T10:12:29Z",
    "expires_at": null,
    "projects_with_write_access": [
      {
        "id": 73,
        "description": null,
        "name": "project2",
        "name_with_namespace": "Sidney Jones / project2",
        "path": "project2",
        "path_with_namespace": "sidney_jones/project2",
        "created_at": "2021-10-25T18:33:17.550Z"
      },
      {
        "id": 74,
        "description": null,
        "name": "project3",
        "name_with_namespace": "Sidney Jones / project3",
        "path": "project3",
        "path_with_namespace": "sidney_jones/project3",
        "created_at": "2021-10-25T18:33:17.666Z"
      }
    ],
    "projects_with_readonly_access": []
  },
  {
    "id": 3,
    "title": "Another Public key",
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDIJFwIL6YNcCgVBLTHgM6hzmoL5vf0ThDKQMWT3HrwCjUCGPwR63vBwn6+/Gx+kx+VTo9FuojzR0O4XfwD3LrYA+oT3ETbn9U4e/VS4AH/G4SDMzgSLwu0YuPe517FfGWhWGQhjiXphkaQ+6bXPmcASWb0RCO5+pYlGIfxv4eFGQ=="
    "fingerprint": "0b:cf:58:40:b9:23:96:c7:ba:44:df:0e:9e:87:5e:75",
    "fingerprint_sha256": "SHA256:lGI/Ys/Wx7PfMhUO1iuBH92JQKYN+3mhJZvWO4Q5ims",
    "created_at": "2013-10-02T11:12:29Z",
    "expires_at": null,
    "projects_with_write_access": [],
    "projects_with_readonly_access": [
      {
        "id": 74,
        "description": null,
        "name": "project3",
        "name_with_namespace": "Sidney Jones / project3",
        "path": "project3",
        "path_with_namespace": "sidney_jones/project3",
        "created_at": "2021-10-25T18:33:17.666Z"
      }
    ]
  }
]

プロジェクトのデプロイキーのリスト

プロジェクトのデプロイキーの一覧を取得します。

GET /projects/:id/deploy_keys

属性	種類	必須	説明
`id`	整数/文字列	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/deploy_keys"

応答例

[
  {
    "id": 1,
    "title": "Public key",
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDNJAkI3Wdf0r13c8a5pEExB2YowPWCSVzfZV22pNBc1CuEbyYLHpUyaD0GwpGvFdx2aP7lMEk35k6Rz3ccBF6jRaVJyhsn5VNnW92PMpBJ/P1UebhXwsFHdQf5rTt082cSxWuk61kGWRQtk4ozt/J2DF/dIUVaLvc+z4HomT41fQ==",
    "fingerprint": "4a:9d:64:15:ed:3a:e6:07:6e:89:36:b3:3b:03:05:d9",
    "fingerprint_sha256": "SHA256:Jrs3LD1Ji30xNLtTVf9NDCj7kkBgPBb2pjvTZ3HfIgU",
    "created_at": "2013-10-02T10:12:29Z",
    "expires_at": null,
    "can_push": false
  },
  {
    "id": 3,
    "title": "Another Public key",
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDIJFwIL6YNcCgVBLTHgM6hzmoL5vf0ThDKQMWT3HrwCjUCGPwR63vBwn6+/Gx+kx+VTo9FuojzR0O4XfwD3LrYA+oT3ETbn9U4e/VS4AH/G4SDMzgSLwu0YuPe517FfGWhWGQhjiXphkaQ+6bXPmcASWb0RCO5+pYlGIfxv4eFGQ=="
    "fingerprint": "0b:cf:58:40:b9:23:96:c7:ba:44:df:0e:9e:87:5e:75",
    "fingerprint_sha256": "SHA256:lGI/Ys/Wx7PfMhUO1iuBH92JQKYN+3mhJZvWO4Q5ims",
    "created_at": "2013-10-02T11:12:29Z",
    "expires_at": null,
    "can_push": false
  }
]

ユーザーのプロジェクトデプロイキーのリスト

GitLab 15.1で導入されました。

指定したユーザー(requeeee)と認証されたユーザー(requester)の共通プロジェクトのデプロイ鍵の一覧を取得します。リクエスト元とリクエスト先の共通プロジェクトから、有効なプロジェクトキーのみをリストアップします。

GET /users/:id_or_username/project_deploy_keys

パラメータを指定します：

属性	種類	必須	説明
`id_or_username`	文字列です。	yes	プロジェクトデプロイキーを取得するユーザーのIDまたはユーザー名。

[
    {
        "id": 1,
        "title": "Key A",
        "created_at": "2022-05-30T12:28:27.855Z",
        "expires_at": null,
        "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILkYXU2fVeO4/0rDCSsswP5iIX2+B6tv15YT3KObgyDl Key",
        "fingerprint": "40:8e:fa:df:70:f7:a7:06:1e:0d:6f:ae:f2:27:92:01",
        "fingerprint_sha256": "SHA256:Ojq2LZW43BFK/AMP81jBkDGn9YpPWYRNcViKBB44LPU"
    },
    {
        "id": 2,
        "title": "Key B",
        "created_at": "2022-05-30T13:34:56.219Z",
        "expires_at": null,
        "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDNJAkI3Wdf0r13c8a5pEExB2YowPWCSVzfZV22pNBc1CuEbyYLHpUyaD0GwpGvFdx2aP7lMEk35k6Rz3ccBF6jRaVJyhsn5VNnW92PMpBJ/P1UebhXwsFHdQf5rTt082cSxWuk61kGWRQtk4ozt/J2DF/dIUVaLvc+z4HomT41fQ==",
        "fingerprint": "4a:9d:64:15:ed:3a:e6:07:6e:89:36:b3:3b:03:05:d9",
        "fingerprint_sha256": "SHA256:Jrs3LD1Ji30xNLtTVf9NDCj7kkBgPBb2pjvTZ3HfIgU",
    }
]

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/20/project_deploy_keys"

応答例

[
  {
    "id": 1,
    "title": "Key A",
    "created_at": "2022-05-30T12:28:27.855Z",
    "expires_at": "2022-10-30T12:28:27.855Z",
    "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILkYXU2fVeO4/0rDCSsswP5iIX2+B6tv15YT3KObgyDl Key",
    "fingerprint": "40:8e:fa:df:70:f7:a7:06:1e:0d:6f:ae:f2:27:92:01",
    "fingerprint_sha256": "SHA256:Ojq2LZW43BFK/AMP81jBkDGn9YpPWYRNcViKBB44LPU"
  }
]

デプロイキーの取得

単一の鍵を取得します。

GET /projects/:id/deploy_keys/:key_id

パラメータを指定します：

属性	種類	必須	説明
`id`	整数/文字列	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`key_id`	整数。	yes	デプロイキーのID

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/deploy_keys/11"

応答例

{
  "id": 1,
  "title": "Public key",
  "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDNJAkI3Wdf0r13c8a5pEExB2YowPWCSVzfZV22pNBc1CuEbyYLHpUyaD0GwpGvFdx2aP7lMEk35k6Rz3ccBF6jRaVJyhsn5VNnW92PMpBJ/P1UebhXwsFHdQf5rTt082cSxWuk61kGWRQtk4ozt/J2DF/dIUVaLvc+z4HomT41fQ==",
  "fingerprint": "4a:9d:64:15:ed:3a:e6:07:6e:89:36:b3:3b:03:05:d9",
  "fingerprint_sha256": "SHA256:Jrs3LD1Ji30xNLtTVf9NDCj7kkBgPBb2pjvTZ3HfIgU",
  "created_at": "2013-10-02T10:12:29Z",
  "expires_at": null,
  "can_push": false
}

デプロイキーの追加

プロジェクトの新しいデプロイキーを作成します。

デプロイキーがすでに別のプロジェクトに存在する場合、元のプロジェクトに同じユーザーがアクセスできる場合にのみ、現在のプロジェクトに結合されます。

POST /projects/:id/deploy_keys

属性	種類	必須	説明
`id`	整数/文字列	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`key`	文字列です。	yes	新しいデプロイキー
`title`	文字列です。	yes	新しいデプロイキーのタイトル
`can_push`	boolean	いいえ	プロジェクトのリポジトリにキープッシュをデプロイできます。
`expires_at`	datetime	いいえ	デプロイキーの有効期限。値が指定されない場合、有効期限はありません。ISO 8601 形式 (`2019-03-15T08:00:00Z`) で指定します。

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" \
     --data '{"title": "My deploy key", "key": "ssh-rsa AAAA...", "can_push": "true"}' \
     "https://gitlab.example.com/api/v4/projects/5/deploy_keys/"

応答例

{
   "key" : "ssh-rsa AAAA...",
   "id" : 12,
   "title" : "My deploy key",
   "can_push": true,
   "created_at" : "2015-08-29T12:44:31.550Z",
   "expires_at": null
}

デプロイキーの更新

プロジェクトのデプロイキーを更新します。

PUT /projects/:id/deploy_keys/:key_id

属性	種類	必須	説明
`id`	整数/文字列	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`can_push`	boolean	いいえ	プロジェクトのリポジトリにキープッシュをデプロイできます。
`title`	文字列です。	いいえ	新しいデプロイキーのタイトル

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" \
     --data '{"title": "New deploy key", "can_push": true}' "https://gitlab.example.com/api/v4/projects/5/deploy_keys/11"

応答例

{
   "id": 11,
   "title": "New deploy key",
   "key": "ssh-rsa AAAA...",
   "created_at": "2015-08-29T12:44:31.550Z",
   "expires_at": null,
   "can_push": true
}

デプロイキーの削除

プロジェクトからデプロイキーを削除します。デプロイキーがこのプロジェクトでのみ使用されている場合、システムから削除されます。

DELETE /projects/:id/deploy_keys/:key_id

属性	種類	必須	説明
`id`	整数/文字列	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`key_id`	整数。	yes	デプロイキーのID

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/deploy_keys/13"

デプロイキーを有効にします。

プロジェクトのデプロイキーを有効にします。有効化されたキーを返し、成功した場合はステータスコード 201 を返します。

POST /projects/:id/deploy_keys/:key_id/enable

属性	種類	必須	説明
`id`	整数/文字列	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`key_id`	整数。	yes	デプロイキーのID

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/deploy_keys/12/enable"

応答例

{
   "key" : "ssh-rsa AAAA...",
   "id" : 12,
   "title" : "My deploy key",
   "created_at" : "2015-08-29T12:44:31.550Z",
   "expires_at": null
}

複数のプロジェクトへのデプロイキーの追加

同じグループ内の複数のプロジェクトに同じデプロイキーを追加したい場合は、APIを使用します。

まず、対象となるプロジェクトの ID を調べます：

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects"

または、グループのIDを探します：

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups"

そのグループの全プロジェクトをリストアップします（例：グループ1234）：

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1234"

これらのIDで、すべてに同じデプロイキーを追加します：

for project_id in 321 456 987; do
    curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
         --header "Content-Type: application/json" \
         --data '{"title": "my key", "key": "ssh-rsa AAAA..."}' \
         "https://gitlab.example.com/api/v4/projects/${project_id}/deploy_keys"
done

デプロイキーAPI

全てのデプロイキーをリストアップ

プロジェクトのデプロイキーのリスト

ユーザーのプロジェクトデプロイキーのリスト

デプロイキーの取得

デプロイキーの追加

デプロイキーの更新

デプロイキーの削除

デプロイキーを有効にします。

複数のプロジェクトへのデプロイキーの追加

Help & feedback

Docs

Product

Feature availability and product trials

Get Help