flywheel.api.site_api
SiteApi
Bases: object
add_provider(body, **kwargs)
Add a new provider
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | IngressProvider | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
add_provider_with_http_info(body, **kwargs)
Add a new provider
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | IngressProvider | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
add_site_rule(body, **kwargs)
Create a new site rule.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | GearRuleInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
add_site_rule_with_http_info(body, **kwargs)
Create a new site rule.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | GearRuleInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_provider(provider_id, **kwargs)
Delete the provider identified by ProviderId
Returns an empty 204 response if successful. The provider will be deleted asynchronously; if it is a storage provider, any files on the provider that have been deleted but not yet cleaned up will be hard deleted. Use the get_provider operation to check the deletion status. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
provider_id | str | The ID of the provider | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_provider_with_http_info(provider_id, **kwargs)
Delete the provider identified by ProviderId
Returns an empty 204 response if successful. The provider will be deleted asynchronously; if it is a storage provider, any files on the provider that have been deleted but not yet cleaned up will be hard deleted. Use the get_provider operation to check the deletion status. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
provider_id | str | The ID of the provider | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_bookmark_list(**kwargs)
Get Bookmark List
Get the bookmark list. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_bookmark_list_with_http_info(**kwargs)
Get Bookmark List
Get the bookmark list. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_provider(provider_id, **kwargs)
Return the provider identified by ProviderId
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
provider_id | str | The ID of the provider | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_provider_config(provider_id, **kwargs)
Return the configuration for provider identified by ProviderId
The returned configuration will be redacted, with any privileged values replaced with null. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
provider_id | str | The ID of the provider | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_provider_config_with_http_info(provider_id, **kwargs)
Return the configuration for provider identified by ProviderId
The returned configuration will be redacted, with any privileged values replaced with null. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
provider_id | str | The ID of the provider | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_provider_with_http_info(provider_id, **kwargs)
Return the provider identified by ProviderId
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
provider_id | str | The ID of the provider | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_providers(**kwargs)
Return a list of all providers on the site
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
_class | (ProviderClass, optional) | Limit the response to the given provider class | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_providers_with_http_info(**kwargs)
Return a list of all providers on the site
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
_class | (ProviderClass, optional) | Limit the response to the given provider class | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_site_rule(rule_id, **kwargs)
Get a site rule.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
rule_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_site_rule_with_http_info(rule_id, **kwargs)
Get a site rule.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
rule_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_site_rules(**kwargs)
List all site rules.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
limit | (int, optional) | | required |
after_id | (str, optional) | | required |
name | (str, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_site_rules_with_http_info(**kwargs)
List all site rules.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
limit | (int, optional) | | required |
after_id | (str, optional) | | required |
name | (str, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_site_settings(**kwargs)
Return administrative site settings
Returns the site settings, which includes center-pays gear list. If the site settings have never been created, then center_gears will be null, rather than an empty list. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_site_settings_with_http_info(**kwargs)
Return administrative site settings
Returns the site settings, which includes center-pays gear list. If the site settings have never been created, then center_gears will be null, rather than an empty list. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_bookmark_list(body, **kwargs)
Modify Bookmark List
Modify the bookmark list. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | list[Bookmark] | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_bookmark_list_with_http_info(body, **kwargs)
Modify Bookmark List
Modify the bookmark list. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | list[Bookmark] | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_provider(provider_id, body, **kwargs)
Update the provider identified by ProviderId
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
provider_id | str | The ID of the provider | required |
body | IngressUpdateProvider | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_provider_with_http_info(provider_id, body, **kwargs)
Update the provider identified by ProviderId
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
provider_id | str | The ID of the provider | required |
body | IngressUpdateProvider | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_site_rule(rule_id, body, **kwargs)
Update a site rule.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
rule_id | str | | required |
body | GearRuleModifyInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_site_rule_with_http_info(rule_id, body, **kwargs)
Update a site rule.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
rule_id | str | | required |
body | GearRuleModifyInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_site_settings(body, **kwargs)
Update administrative site settings
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | IngressSiteSettings | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_site_settings_with_http_info(body, **kwargs)
Update administrative site settings
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | IngressSiteSettings | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
remove_site_rule(rule_id, **kwargs)
Remove a site rule.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
rule_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
remove_site_rule_with_http_info(rule_id, **kwargs)
Remove a site rule.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
rule_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |