Skip to content
forgit api docs

Get a SSH key

GET
/users/{selected_user}/ssh-keys/{key_id}

Returns a specific SSH public key belonging to a user.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
key_id
required
string

The SSH key’s UUID value.

selected_user
required
string

This can either be an Atlassian Account ID OR the UUID of the account, surrounded by curly-braces, for example: {account UUID}.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The specific SSH key matching the user and UUID

Media type application/json
object
type
required
string
uuid

The SSH key’s immutable ID.

string
key

The SSH public key value in OpenSSH format.

string
comment

The comment parsed from the SSH key (if present)

string
label

The user-defined label for the SSH key

string
created_on
string format: date-time
last_used
string format: date-time
links
object
self
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
owner
object
type
required
string
links
Account Links

Links related to an Account.

object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
key
additional properties
any
created_on
string format: date-time
display_name
string
uuid
string
expires_on
string format: date-time
fingerprint

The SSH key fingerprint in SHA-256 format.

string
Examples
Example response 
{
  "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

Section titled “ 403 ”

If the specified user or key is not accessible to the current user

404

Section titled “ 404 ”

If the specified user or key does not exist

Media type application/json
Error

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.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}