Addon3

Branch restrictions5

Branching model7

Commit statuses4

Commits17

Deployments16

Downloads4

GPG4

Merge queues5

Pipelines68

Projects16

properties12

Pullrequests38

Refs9

Reports9

Repositories24

Search3

Snippets24

Source4

SSH5

Users4

Webhooks2

Workspaces17

SSH

Add a new SSH key

Changed on Jul 13, 2026

Adds a new SSH public key to the specified user account and returns the resulting key.

Example:

$ curl -X POST -H "Content-Type: application/json" -d '{"key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY user@myhost"}' https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys

post/users/{selected_user}/ssh-keys

Request

Base URL
https://api.bitbucket.org/2.0
URL
https://api.bitbucket.org/2.0/users/{selected_user}/ssh-keys
Auth
- OAuth 2
  Authorization code: https://bitbucket.org/site/oauth2/authorize
  Token URL: https://bitbucket.org/site/oauth2/access_token scopes: account:write
- or HTTP basic
- or API key in header Authorization

Query parameters

expires_onstring

The date or date-time of when the key will expire, in ISO-8601 format. Example: YYYY-MM-DDTHH:mm:ss.sssZ

Request body

typestring required

uuidstring

The SSH key's immutable ID.

keystring

The SSH public key value in OpenSSH format.

commentstring

The comment parsed from the SSH key (if present)

labelstring

The user-defined label for the SSH key

created_onstring date-time

last_usedstring date-time

expires_onstring date-time

fingerprintstring

The SSH key fingerprint in SHA-256 format.

Response

The newly created SSH key.