Skip to content

Latest commit

 

History

History
160 lines (91 loc) · 5.03 KB

SshKeysApi.md

File metadata and controls

160 lines (91 loc) · 5.03 KB

\SshKeysApi

All URIs are relative to https://api.scaleway.com

Method HTTP request Description
create_ssh_key POST /iam/v1alpha1/ssh-keys Create an SSH key
delete_ssh_key DELETE /iam/v1alpha1/ssh-keys/{ssh_key_id} Delete an SSH key
get_ssh_key GET /iam/v1alpha1/ssh-keys/{ssh_key_id} Get an SSH key
list_ssh_keys GET /iam/v1alpha1/ssh-keys List SSH keys
update_ssh_key PATCH /iam/v1alpha1/ssh-keys/{ssh_key_id} Update an SSH key

create_ssh_key

crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodSshKey create_ssh_key(create_ssh_key_request) Create an SSH key

Parameters

Name Type Description Required Notes
create_ssh_key_request CreateSshKeyRequest [required]

Return type

crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodSshKey

Authorization

scaleway

HTTP request headers

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

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

delete_ssh_key

delete_ssh_key(ssh_key_id) Delete an SSH key

Parameters

Name Type Description Required Notes
ssh_key_id String [required]

Return type

(empty response body)

Authorization

scaleway

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

get_ssh_key

crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodSshKey get_ssh_key(ssh_key_id) Get an SSH key

Parameters

Name Type Description Required Notes
ssh_key_id String The ID of the SSH key [required]

Return type

crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodSshKey

Authorization

scaleway

HTTP request headers

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

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

list_ssh_keys

crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodListSshKeysResponse list_ssh_keys(order_by, page, page_size, organization_id, name, project_id, disabled) List SSH keys

Parameters

Name Type Description Required Notes
order_by Option<String> Sort order of SSH keys [default to created_at_asc]
page Option<i32> Requested page number. Value must be greater or equals to 1
page_size Option<i32> Number of items per page. Value must be between 1 and 100
organization_id Option<String> Filter by organization ID
name Option<String> Name of group to find
project_id Option<String> Filter by project ID
disabled Option<bool> Filter out disabled SSH keys or not

Return type

crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodListSshKeysResponse

Authorization

scaleway

HTTP request headers

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

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

update_ssh_key

crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodSshKey update_ssh_key(ssh_key_id, update_ssh_key_request) Update an SSH key

Parameters

Name Type Description Required Notes
ssh_key_id String [required]
update_ssh_key_request UpdateSshKeyRequest [required]

Return type

crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodSshKey

Authorization

scaleway

HTTP request headers

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

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