Skip to content

Latest commit

 

History

History
179 lines (113 loc) · 5.89 KB

SshKeyApi.md

File metadata and controls

179 lines (113 loc) · 5.89 KB

\SshKeyApi

All URIs are relative to https://core.hivelocity.net/api/v2

Method HTTP request Description
DeleteSshKeyIdResource Delete /ssh_key/{sshKeyId} Removes public ssh key
GetSshKeyIdResource Get /ssh_key/{sshKeyId} Get public ssh key
GetSshKeyResource Get /ssh_key/ Gets all public ssh key
PostSshKeyResource Post /ssh_key/ Adds public ssh key
PutSshKeyIdResource Put /ssh_key/{sshKeyId} Updates public ssh key

DeleteSshKeyIdResource

DeleteSshKeyIdResource(ctx, sshKeyId) Removes public ssh key

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
sshKeyId int32

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

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

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

GetSshKeyIdResource

SshKeyResponse GetSshKeyIdResource(ctx, sshKeyId, optional) Get public ssh key

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
sshKeyId int32
optional *SshKeyApiGetSshKeyIdResourceOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SshKeyApiGetSshKeyIdResourceOpts struct

Name Type Description Notes

xFields | optional.String| An optional fields mask |

Return type

SshKeyResponse

Authorization

apiKey

HTTP request headers

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

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

GetSshKeyResource

[]SshKeyResponse GetSshKeyResource(ctx, optional) Gets all public ssh key

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *SshKeyApiGetSshKeyResourceOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SshKeyApiGetSshKeyResourceOpts struct

Name Type Description Notes
xFields optional.String An optional fields mask

Return type

[]SshKeyResponse

Authorization

apiKey

HTTP request headers

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

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

PostSshKeyResource

SshKeyResponse PostSshKeyResource(ctx, payload, optional) Adds public ssh key

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
payload SshKey
optional *SshKeyApiPostSshKeyResourceOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SshKeyApiPostSshKeyResourceOpts struct

Name Type Description Notes

xFields | optional.String| An optional fields mask |

Return type

SshKeyResponse

Authorization

apiKey

HTTP request headers

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

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

PutSshKeyIdResource

SshKeyResponse PutSshKeyIdResource(ctx, sshKeyId, payload, optional) Updates public ssh key

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
sshKeyId int32
payload SshKeyUpdate
optional *SshKeyApiPutSshKeyIdResourceOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SshKeyApiPutSshKeyIdResourceOpts struct

Name Type Description Notes

xFields | optional.String| An optional fields mask |

Return type

SshKeyResponse

Authorization

apiKey

HTTP request headers

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

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