Bitbucket SSH API

The SSH resource allows you to manage SSH keys.

Documentation GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /users/{selected_user}/ssh-keys List a user's SSH keys · List SSH keys #

Ask an LLM

“Which SSH keys are on my Bitbucket account?”

“Can I audit a user's SSH public keys?”

Tell an agent

List SSH keys for user {selected_user}.

Show every SSH public key on account {selected_user}.

POST /users/{selected_user}/ssh-keys Add an SSH key to a user · Add a new SSH key #

Ask an LLM

“How do I add a new SSH key to my account?”

“Can I set an expiry date on an SSH key when adding it?”

Tell an agent

Add an SSH key to user {selected_user}.

Add an SSH key to {selected_user} that expires on {expires_on}.

DELETE /users/{selected_user}/ssh-keys/{key_id} Delete an SSH key · Delete a SSH key #

Ask an LLM

“How do I revoke an SSH key from my account?”

“Can I remove an old laptop's SSH key?”

Tell an agent destructive · confirm first

Delete SSH key {key_id} from user {selected_user}.

Remove SSH key {key_id} from my account.

GET /users/{selected_user}/ssh-keys/{key_id} Get an SSH key · Get a SSH key #

Ask an LLM

“Can I look up one SSH key by its id?”

“What is the fingerprint and comment on a particular SSH key?”

Tell an agent

Get SSH key {key_id} for user {selected_user}.

Show SSH key {key_id}'s fingerprint.

PUT /users/{selected_user}/ssh-keys/{key_id} Update an SSH key's comment · Update a SSH key #

Ask an LLM

“How do I change the label on an existing SSH key?”

“Which fields of an SSH key can be edited after it is added?”

Tell an agent

Update the comment on SSH key {key_id} for {selected_user}.

Relabel existing SSH key {key_id}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/bitbucket:bitbucket-ssh-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Bitbucket SSH API
  description: Code against the Bitbucket API to automate simple tasks, embed Bitbucket data into your own site, build mobile or desktop apps, or even add custom UI add-ons into Bitbucket itself using the Connect framework.
  version: '2.0'
  termsOfService: https://www.atlassian.com/legal/customer-agreement
  contact:
    name: Bitbucket Support
    url: https://support.atlassian.com/bitbucket-cloud/
    email: support@bitbucket.org
servers:
- url: https://api.bitbucket.org/2.0
tags:
- name: SSH
  description: The SSH resource allows you to manage SSH keys.
paths:
  /users/{selected_user}/ssh-keys:
    parameters:
    - name: selected_user
      in: path
      description: 'This can either be an Atlassian Account ID OR the UUID of the account,

        surrounded by curly-braces, for example: `{account UUID}`.

        '
      required: true
      schema:
        type: string
    get:
      tags:
      - SSH
      description: Returns a paginated list of the user's SSH public keys.
      summary: List SSH keys
      responses:
        '200':
          description: A list of the SSH keys associated with the account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_ssh_user_keys'
              example:
                page: 1
                pagelen: 10
                size: 1
                values:
                - comment: user@myhost
                  created_on: '2018-03-14T13:17:05.196003+00:00'
                  expires_on: null
                  fingerprint: w9tZSiFoZ8oXwS4ZSWrJopGxwvnPIewA6Mo4owAHPrI
                  key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY
                  label: ''
                  last_used: '2018-03-20T13:18:05.196003+00:00'
                  links:
                    self:
                      href: https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a
                  owner:
                    display_name: Mark Adams
                    links:
                      avatar:
                        href: https://bitbucket.org/account/markadams-atl/avatar/32/
                      html:
                        href: https://bitbucket.org/markadams-atl/
                      self:
                        href: https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}
                    type: user
                    username: markadams-atl
                    nickname: markadams-atl
                    uuid: '{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}'
                  type: ssh_key
                  uuid: '{b15b6026-9c02-4626-b4ad-b905f99f763a}'
        '403':
          description: If the specified user's keys are not accessible to the current user
        '404':
          description: If the specified user does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
      - oauth2:
        - account
      - basic: []
      - api_key: []
      x-atlassian-oauth2-scopes:
      - state: Current
        scheme: oauth2
        scopes:
        - read:ssh-key:bitbucket
      x-atlassian-auth-types:
      - api-token
      operationId: getUsersBySelectedUserSshKeys
      x-operation-id-source: derived
    post:
      tags:
      - SSH
      description: '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

        ```'
      summary: Add a new SSH key
      responses:
        '201':
          description: The newly created SSH key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssh_account_key'
              example:
                comment: user@myhost
                created_on: '2018-03-14T13:17:05.196003+00:00'
                expires_on: null
                fingerprint: w9tZSiFoZ8oXwS4ZSWrJopGxwvnPIewA6Mo4owAHPrI
                key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY
                label: ''
                last_used: '2018-03-20T13:18:05.196003+00:00'
                links:
                  self:
                    href: https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a
                owner:
                  display_name: Mark Adams
                  links:
                    avatar:
                      href: https://bitbucket.org/account/markadams-atl/avatar/32/
                    html:
                      href: https://bitbucket.org/markadams-atl/
                    self:
                      href: https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}
                  type: user
                  username: markadams-atl
                  nickname: markadams-atl
                  uuid: '{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}'
                type: ssh_key
                uuid: '{b15b6026-9c02-4626-b4ad-b905f99f763a}'
        '400':
          description: If the submitted key or related value is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '403':
          description: If the current user does not have permission to add a key for the specified user
        '404':
          description: If the specified user does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - name: expires_on
        in: query
        description: 'The date or date-time of when the key will expire,

          in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format.

          Example: `YYYY-MM-DDTHH:mm:ss.sssZ`'
        required: false
        schema:
          type: string
      security:
      - oauth2:
        - account:write
      - basic: []
      - api_key: []
      x-atlassian-oauth2-scopes:
      - state: Current
        scheme: oauth2
        scopes:
        - read:ssh-key:bitbucket
        - write:ssh-key:bitbucket
      x-atlassian-auth-types:
      - api-token
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ssh_account_key'
        description: The new SSH key object. Note that the username property has been deprecated due to [privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis).
      operationId: postUsersBySelectedUserSshKeys
      x-operation-id-source: derived
  /users/{selected_user}/ssh-keys/{key_id}:
    parameters:
    - name: key_id
      in: path
      description: The SSH key's UUID value.
      required: true
      schema:
        type: string
    - name: selected_user
      in: path
      description: 'This can either be an Atlassian Account ID OR the UUID of the account,

        surrounded by curly-braces, for example: `{account UUID}`.

        '
      required: true
      schema:
        type: string
    delete:
      tags:
      - SSH
      description: Deletes a specific SSH public key from a user's account.
      summary: Delete a SSH key
      responses:
        '204':
          description: The key has been deleted
        '400':
          description: If the submitted key or related value is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '403':
          description: If the current user does not have permission to add a key for the specified user
        '404':
          description: If the specified user does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
      - oauth2:
        - account:write
      - basic: []
      - api_key: []
      x-atlassian-oauth2-scopes:
      - state: Current
        scheme: oauth2
        scopes:
        - delete:ssh-key:bitbucket
      x-atlassian-auth-types:
      - api-token
      operationId: deleteUsersBySelectedUserSshKeysByKeyId
      x-operation-id-source: derived
    get:
      tags:
      - SSH
      description: Returns a specific SSH public key belonging to a user.
      summary: Get a SSH key
      responses:
        '200':
          description: The specific SSH key matching the user and UUID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssh_account_key'
              example:
                comment: user@myhost
                created_on: '2018-03-14T13:17:05.196003+00:00'
                expires_on: null
                fingerprint: w9tZSiFoZ8oXwS4ZSWrJopGxwvnPIewA6Mo4owAHPrI
                key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY
                label: ''
                last_used: '2018-03-20T13:18:05.196003+00:00'
                links:
                  self:
                    href: https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a
                owner:
                  display_name: Mark Adams
                  links:
                    avatar:
                      href: https://bitbucket.org/account/markadams-atl/avatar/32/
                    html:
                      href: https://bitbucket.org/markadams-atl/
                    self:
                      href: https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}
                  type: user
                  username: markadams-atl
                  nickname: markadams-atl
                  uuid: '{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}'
                type: ssh_key
                uuid: '{b15b6026-9c02-4626-b4ad-b905f99f763a}'
        '403':
          description: If the specified user or key is not accessible to the current user
        '404':
          description: If the specified user or key does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
      - oauth2:
        - account
      - basic: []
      - api_key: []
      x-atlassian-oauth2-scopes:
      - state: Current
        scheme: oauth2
        scopes:
        - read:ssh-key:bitbucket
      x-atlassian-auth-types:
      - api-token
      operationId: getUsersBySelectedUserSshKeysByKeyId
      x-operation-id-source: derived
    put:
      tags:
      - SSH
      description: 'Updates a specific SSH public key on a user''s account


        Note: Only the ''comment'' field can be updated using this API. To modify the key or comment values, you must delete and add the key again.


        Example:


        ```

        $ curl -X PUT -H "Content-Type: application/json" -d ''{"label": "Work key"}'' https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/{b15b6026-9c02-4626-b4ad-b905f99f763a}

        ```'
      summary: Update a SSH key
      responses:
        '200':
          description: The newly updated SSH key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssh_account_key'
              example:
                comment: ''
                created_on: '2018-03-14T13:17:05.196003+00:00'
                expires_on: null
                fingerprint: w9tZSiFoZ8oXwS4ZSWrJopGxwvnPIewA6Mo4owAHPrI
                key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY
                label: Work key
                last_used: '2018-03-20T13:18:05.196003+00:00'
                links:
                  self:
                    href: https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a
                owner:
                  display_name: Mark Adams
                  links:
                    avatar:
                      href: https://bitbucket.org/account/markadams-atl/avatar/32/
                    html:
                      href: https://bitbucket.org/markadams-atl/
                    self:
                      href: https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}
                  type: user
                  username: markadams-atl
                  nickname: markadams-atl
                  uuid: '{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}'
                type: ssh_key
                uuid: '{b15b6026-9c02-4626-b4ad-b905f99f763a}'
        '400':
          description: If the submitted key or related value is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '403':
          description: If the current user does not have permission to add a key for the specified user
        '404':
          description: If the specified user does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
      - oauth2:
        - account:write
      - basic: []
      - api_key: []
      x-atlassian-oauth2-scopes:
      - state: Current
        scheme: oauth2
        scopes:
        - read:ssh-key:bitbucket
        - write:ssh-key:bitbucket
      x-atlassian-auth-types:
      - api-token
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ssh_account_key'
        description: The updated SSH key object
      operationId: putUsersBySelectedUserSshKeysByKeyId
      x-operation-id-source: derived
components:
  schemas:
    ssh_account_key:
      allOf:
      - $ref: '#/components/schemas/ssh_key'
      - type: object
        title: SSH Account Key
        description: Represents an SSH public key for a user.
        properties:
          owner:
            $ref: '#/components/schemas/account'
          expires_on:
            type: string
            format: date-time
          fingerprint:
            type: string
            description: The SSH key fingerprint in SHA-256 format.
        additionalProperties: true
    account_links:
      type: object
      title: Account Links
      description: Links related to an Account.
      properties:
        avatar:
          $ref: '#/components/schemas/link'
      additionalProperties: true
    object:
      type: object
      description: Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`.
      properties:
        type:
          type: string
      required:
      - type
      additionalProperties: true
      discriminator:
        propertyName: type
    account:
      allOf:
      - $ref: '#/components/schemas/object'
      - type: object
        title: Account
        description: An account object.
        properties:
          links:
            $ref: '#/components/schemas/account_links'
          created_on:
            type: string
            format: date-time
          display_name:
            type: string
          uuid:
            type: string
        additionalProperties: true
    ssh_key:
      allOf:
      - $ref: '#/components/schemas/object'
      - type: object
        title: SSH Key
        description: Base type for representing SSH public keys.
        properties:
          uuid:
            type: string
            description: The SSH key's immutable ID.
          key:
            type: string
            description: The SSH public key value in OpenSSH format.
          comment:
            type: string
            description: The comment parsed from the SSH key (if present)
          label:
            type: string
            description: The user-defined label for the SSH key
          created_on:
            type: string
            format: date-time
          last_used:
            type: string
            format: date-time
          links:
            type: object
            properties:
              self:
                type: object
                title: Link
                description: A link to a resource related to this object.
                properties:
                  href:
                    type: string
                    format: uri
                  name:
                    type: string
                additionalProperties: false
            additionalProperties: false
        additionalProperties: true
    link:
      type: object
      title: Link
      description: A link to a resource related to this object.
      properties:
        href:
          type: string
          format: uri
        name:
          type: string
      additionalProperties: false
    paginated_ssh_user_keys:
      type: object
      title: Paginated SSH User Keys
      description: A paginated list of SSH keys.
      properties:
        size:
          type: integer
          description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.
          minimum: 0
        page:
          type: integer
          description: Page number of the current results. This is an optional element that is not provided in all responses.
          minimum: 1
        pagelen:
          type: integer
          description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.
          minimum: 1
        next:
          type: string
          description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.
          format: uri
        previous:
          type: string
          description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.
          format: uri
        values:
          type: array
          items:
            $ref: '#/components/schemas/ssh_account_key'
          minItems: 0
          uniqueItems: true
      additionalProperties: false
    error:
      type: object
      title: Error
      description: Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`.
      properties:
        type:
          type: string
        error:
          type: object
          properties:
            message:
              type: string
            detail:
              type: string
            data:
              type: object
              description: Optional structured data that is endpoint-specific.
              properties: {}
              additionalProperties: true
          required:
          - message
          additionalProperties: false
      required:
      - type
      additionalProperties: true
  securitySchemes:
    basic:
      type: http
      scheme: basic
      description: Basic HTTP Authentication as per [RFC-2617](https://tools.ietf.org/html/rfc2617) (Digest not supported). Note that Basic Auth is available only with username and app password as credentials.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            repository: Read your repositories
            repository:write: Read and modify your repositories
            repository:admin: Administer your repositories
            repository:delete: Delete your repositories
            project: Read your workspace's project settings and read repositories contained within your workspace's projects
            project:admin: Read and modify settings for projects in your workspace
            email: Read your account's primary email address
            account: Read your account information
            account:write: Read and modify your account information
            team: Read your team membership information
            team:write: Read and modify your team membership information
            pipeline: Access your repositories' build pipelines
            pipeline:write: Access and rerun your repositories' build pipelines
            pipeline:variable: Access your repositories' build pipelines and configure their variables
            runner: Access your workspaces/repositories' runners
            runner:write: Access and edit your workspaces/repositories' runners
            test: Access your workspaces/repositories' test
            test:write: Access and edit your workspaces/repositories' test
            pullrequest: Read your repositories and their pull requests
            pullrequest:write: Read and modify your repositories and their pull requests
            webhook: Read and modify your repositories' webhooks
            issue: Read your repositories' issues
            issue:write: Read and modify your repositories' issues
            snippet: Read your snippets
            snippet:write: Read and modify your snippets
            wiki: Read and modify your repositories' wikis
          authorizationUrl: https://bitbucket.org/site/oauth2/authorize
          tokenUrl: https://bitbucket.org/site/oauth2/access_token
      description: OAuth 2 as per [RFC-6749](https://tools.ietf.org/html/rfc6749).
    api_key:
      name: Authorization
      type: apiKey
      description: API Keys can be used as Basic HTTP Authentication credentials and provide a substitute for the account's actual username and password. API Keys are only available to team accounts and there is only 1 key per account. API Keys do not support scopes and have therefore access to all contents of the account.
      in: header
x-revision: 84a5dd73aa83
x-atlassian-narrative:
  documents:


# --- truncated at 32 KB (132 KB total) ---
# Full source: https://artifacts.apis.io/bitbucket/openapi/bitbucket-ssh-api-openapi.yml

Bitbucket SSH API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification