Skip to content

Latest commit

 

History

History
175 lines (107 loc) · 12.6 KB

SshApi.md

File metadata and controls

175 lines (107 loc) · 12.6 KB
Raw

\SshApi

All URIs are relative to https://api.bitbucket.org/2.0

Method HTTP request Description
UsersUsernameSshKeysDelete Delete /users/{username}/ssh-keys/
UsersUsernameSshKeysGet Get /users/{username}/ssh-keys/
UsersUsernameSshKeysGet_0 Get /users/{username}/ssh-keys
UsersUsernameSshKeysPost Post /users/{username}/ssh-keys
UsersUsernameSshKeysPut Put /users/{username}/ssh-keys/

UsersUsernameSshKeysDelete

UsersUsernameSshKeysDelete(ctx, username, keyId)

Deletes a specific SSH public key from a user's account Example: $ curl -X DELETE https://api.bitbucket.org/2.0/users/markadams-atl/ssh-keys/{b15b6026-9c02-4626-b4ad-b905f99f763a}

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string The account's username or UUID.
keyId string The SSH key's UUID value.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersUsernameSshKeysGet

SshAccountKey UsersUsernameSshKeysGet(ctx, username, keyId)

Returns a specific SSH public key belonging to a user. Example: $ curl https://api.bitbucket.org/2.0/users/markadams-atl/ssh-keys/{fbe4bbab-f6f7-4dde-956b-5c58323c54b3} { \"comment\": \"user@myhost\", \"created_on\": \"2018-03-14T13:17:05.196003+00:00\", \"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/markadams-atl/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/markadams-atl\" } }, \"type\": \"user\", \"username\": \"markadams-atl\", \"nickname\": \"markadams-atl\", \"uuid\": \"{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}\" }, \"type\": \"ssh_key\", \"uuid\": \"{b15b6026-9c02-4626-b4ad-b905f99f763a}\" }

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string The account's username or UUID.
keyId string The SSH key's UUID value.

Return type

SshAccountKey

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersUsernameSshKeysGet_0

PaginatedSshUserKeys UsersUsernameSshKeysGet_0(ctx, username)

Returns a paginated list of the user's SSH public keys. Example: $ curl https://api.bitbucket.org/2.0/users/markadams-atl/ssh-keys { \"page\": 1, \"pagelen\": 10, \"size\": 1, \"values\": [ { \"comment\": \"user@myhost\", \"created_on\": \"2018-03-14T13:17:05.196003+00:00\", \"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/markadams-atl/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/markadams-atl\" } }, \"type\": \"user\", \"username\": \"markadams-atl\", \"nickname\": \"markadams-atl\", \"uuid\": \"{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}\" }, \"type\": \"ssh_key\", \"uuid\": \"{b15b6026-9c02-4626-b4ad-b905f99f763a}\" } ] }

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string The account's UUID, account_id, or username. Note that username has been deprecated due to privacy changes.

Return type

PaginatedSshUserKeys

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersUsernameSshKeysPost

SshAccountKey UsersUsernameSshKeysPost(ctx, username, optional)

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/markadams-atl/ssh-keys { \"comment\": \"user@myhost\", \"created_on\": \"2018-03-14T13:17:05.196003+00:00\", \"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/markadams-atl/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/markadams-atl\" } }, \"type\": \"user\", \"username\": \"markadams-atl\", \"nickname\": \"markadams-atl\", \"uuid\": \"{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}\" }, \"type\": \"ssh_key\", \"uuid\": \"{b15b6026-9c02-4626-b4ad-b905f99f763a}\" }

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string The account's UUID, account_id, or username. Note that username has been deprecated due to privacy changes.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
username string The account's UUID, account_id, or username. Note that username has been deprecated due to privacy changes.
body SshAccountKey The new SSH key object. Note that the username property has been deprecated due to privacy changes.

Return type

SshAccountKey

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersUsernameSshKeysPut

SshAccountKey UsersUsernameSshKeysPut(ctx, username, keyId, optional)

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/markadams-atl/ssh-keys/{b15b6026-9c02-4626-b4ad-b905f99f763a} { \"comment\": \"\", \"created_on\": \"2018-03-14T13:17:05.196003+00:00\", \"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/markadams-atl/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/markadams-atl\" } }, \"type\": \"user\", \"username\": \"markadams-atl\", \"nickname\": \"markadams-atl\", \"uuid\": \"{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}\" }, \"type\": \"ssh_key\", \"uuid\": \"{b15b6026-9c02-4626-b4ad-b905f99f763a}\" }

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string The account's username or UUID.
keyId string The SSH key's UUID value.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
username string The account's username or UUID.
keyId string The SSH key's UUID value.
body SshAccountKey The updated SSH key object

Return type

SshAccountKey

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]