deploy-keys リソース

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

Bitbucket Cloud v1 API は廃止予定です

Bitbucket Cloud REST API バージョン 1 は 2018 年 6 月 30 日に廃止予定です。すべての 1.0 API は、2019 年 4 月 12 日に、REST API から完全に削除されます。廃止についての告知をご確認ください。また、バージョン 2.0 の REST API ドキュメントをご確認ください。

概要

Manage ssh keys used for deploying product builds. All the calls for this resource require authentication as the account owner. The deploy-keys fields are the following:

フィールド 説明
pk キーの識別子 (ID)。
key 公開キーの値。
label ユーザーに表示される、キーのラベル。

既存のデプロイ キーを更新することはできません。この場合、キーを DELETE し、新しいものを POST 呼び出しで再作成します。

キー一覧の GET

リポジトリに関連付けられているキーの一覧を取得します。この呼び出しでは、次のパラメーターを指定できます。

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント。
repo_slug はい リポジトリ識別子 (リポジトリの名前とは異なります)。
GET https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/deploy-keys 
ここをクリックしてレスポンスを展開...
[
    {
        "pk": 171092,
        "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDMl/FZf9AtrJBth+8swfDfJrRWetHHnew/LTwX86OGdcG4sJWE9QpWzO9K+szpxaFmMF729
bKAUBMBWNoPrYApayyalirpe7fjzHqIWoq9CsP/wKDVSyMxVOiBwBnXSukS7i9iOiC2J9PyEQwAq7GJXI3E2UWyymW7rVyaDdYKLH9PdUMNmLfBpsDUyjdGO40pLj
r6KCiyOTLI07Qy9iVz44VTRm6IBlxhee0DV3gw4GADHllSRVVOOngO+3493943sgfsfgsgsffgs3349349DFG346qi4WTeECB6JH87Fhd
CGS6mFyavpvOnrZdR9jGD auserbb",
        "label": "bamboo-agent"
    }
]

キーのコンテンツの GET

Gets the content of the specified key_id. This call requires authentication. You can specify the following parameters with this call:

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント。
repo_slug はい リポジトリ識別子 (リポジトリの名前とは異なります)。
pk はい Bitbucket によって割り当てられるキー識別子。GET 呼び出しを使用してこの値を取得します。
 GET https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/deploy-keys/{pk}
ここをクリックして展開...
[
    {
        "pk": 171092,
        "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDMl/FZf9AtrJBth+8swfDfJrRWetHHnew/LTwX86OGdcG4sJWE9QpWzO9K+szpxaFmMF729
bKAUBMBWNoPrYApayyalirpe7fjzHqIWoq9CsP/wKDVSyMxVOiBwBnXSukS7i9iOiC2J9PyEQwAq7GJXI3E2UWyymW7rVyaDdYKLH9PdUMNmLfBpsDUyjdGO40pLj
r6KCiyOTLI07Qy9iVz44VTRm6IBlxhee0DV3gw4GADHllSRVVOOngO+3493943sgfsfgsgsffgs3349349DFG346qi4WTeECB6JH87Fhd
CGS6mFyavpvOnrZdR9jGD auserbb",
        "label": "bamboo-agent"
    }
]

新しいキーの POST

Creates a key on the specified account. You must supply a valid key that is unique across the Bitbucket service. A public key contains characters need to be escaped before sending it as a POST data. So, use the proper escaping ( urlencode ), if you are testing to add a key via your terminal. This call requires authentication. You can specify the following parameters with this call:

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント。
repo_slug はい リポジトリ識別子 (リポジトリの名前とは異なります)。
label いいえ キーの表示名。
key はい キーのコンテンツ。
POST https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/deploy-keys --data "key=value"
ここをクリックしてレスポンスを展開...
[
    {
        "pk": 171092,
        "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDMl/FZf9AtrJBth+8swfDfJrRWetHHnew/LTwX86OGdcG4sJWE9QpWzO9K+szpxaFmMF729
bKAUBMBWNoPrYApayyalirpe7fjzHqIWoq9CsP/wKDVSyMxVOiBwBnXSukS7i9iOiC2J9PyEQwAq7GJXI3E2UWyymW7rVyaDdYKLH9PdUMNmLfBpsDUyjdGO40pLj
r6KCiyOTLI07Qy9iVz44VTRm6IBlxhee0DV3gw4GADHllSRVVOOngO+3493943sgfsfgsgsffgs3349349DFG346qi4WTeECB6JH87Fhd
CGS6mFyavpvOnrZdR9jGD auserbb",
        "label": "bamboo-agent"
    }
]

キーの DELETE

Deletes the key specified by the key_id value. This call requires authentication. You can specify the following parameters with this call:

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント。
repo_slug はい リポジトリ識別子 (リポジトリの名前とは異なります)。
pk はい Bitbucket によって割り当てられるキー識別子。GET 呼び出しを使用してこの値を取得します。
DELETE https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/deploy-keys/{pk}

正常に完了すると、HTTP 204 が返されます。

最終更新日 2018 年 6 月 14 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.