deploy-keys Resource

Overview

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:

Field Description
pk The key identifier (ID).
key Public key value.
label The user-visible label on the key.

You cannot update an existing deploy key.  Instead, you must DELETE the key and recreate a new one with a POST call.

GET a list of keys

Gets a list of the keys associated with an repository. You can specify the following parameters with this call:

Parameter
Required?
Description
accountname Yes The team or individual account.
repo_slug Yes The repo identifier (not to be confused with the repo's name).
GET https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/deploy-keys 
  Click here to expand the response...

GET the key's content

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

Parameter
Required?
Description
accountname Yes The team or individual account.
repo_slug Yes The repo identifier (not to be confused with the repo's name).
pk Yes The key identifier assigned by Bitbucket. Use the GET call to obtain this value.
 GET https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/deploy-keys/{pk}
  Click here to expand...

POST a new key

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:

Parameter
Required?
Description
accountname Yes The team or individual account.
repo_slug Yes The repo identifier (not to be confused with the repo's name).
label No A display name for the key.
key Yes The content of the key.
POST https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/deploy-keys --data "key=value"
  Click here to expand the response...

DELETE a key

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

Parameter
Required?
Description
accountname Yes The team or individual account.
repo_slug Yes The repo identifier (not to be confused with the repo's name).
pk Yes The key identifier assigned by Bitbucket. Use the GET call to obtain this value.
DELETE https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/deploy-keys/{pk}

Returns HTTP 204 on success.

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport