Skip to content

Latest commit

 

History

History
143 lines (83 loc) · 4.75 KB

OptionsApi.md

File metadata and controls

143 lines (83 loc) · 4.75 KB

\OptionsApi

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

Method HTTP request Description
get_option GET /baremetal/v1/zones/{zone}/options/{option_id} Get option
list_options GET /baremetal/v1/zones/{zone}/options List options
list_settings GET /baremetal/v1/zones/{zone}/settings List all settings
update_setting PATCH /baremetal/v1/zones/{zone}/settings/{setting_id} Update setting

get_option

crate::models::ScalewayPeriodBaremetalPeriodV1PeriodOption get_option(zone, option_id) Get option

Return specific option for the given ID.

Parameters

Name Type Description Required Notes
zone String The zone you want to target [required]
option_id String ID of the option [required]

Return type

crate::models::ScalewayPeriodBaremetalPeriodV1PeriodOption

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_options

crate::models::ScalewayPeriodBaremetalPeriodV1PeriodListOptionsResponse list_options(zone, page, page_size, offer_id, name) List options

List all options matching with filters.

Parameters

Name Type Description Required Notes
zone String The zone you want to target [required]
page Option<i32> Page number [default to 1]
page_size Option<i32> Number of options per page [default to 20]
offer_id Option<String> Filter options by offer_id
name Option<String> Filter options by name

Return type

crate::models::ScalewayPeriodBaremetalPeriodV1PeriodListOptionsResponse

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_settings

crate::models::ScalewayPeriodBaremetalPeriodV1PeriodListSettingsResponse list_settings(zone, project_id, page, page_size, order_by) List all settings

Return all settings for a project ID.

Parameters

Name Type Description Required Notes
zone String The zone you want to target [required]
project_id Option<String> ID of the project (UUID format) [required]
page Option<i32> Page number [default to 1]
page_size Option<i32> Set the maximum list size [default to 20]
order_by Option<String> Order the response [default to created_at_asc]

Return type

crate::models::ScalewayPeriodBaremetalPeriodV1PeriodListSettingsResponse

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_setting

crate::models::ScalewayPeriodBaremetalPeriodV1PeriodSetting update_setting(zone, setting_id, update_setting_request) Update setting

Update a setting for a project ID (enable or disable).

Parameters

Name Type Description Required Notes
zone String The zone you want to target [required]
setting_id String ID of the setting [required]
update_setting_request UpdateSettingRequest [required]

Return type

crate::models::ScalewayPeriodBaremetalPeriodV1PeriodSetting

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]