KatapultAPI - the Ruby gem for the Katapult Core API
Welcome to the documentation for the Katapult Core API
This SDK is automatically generated by the OpenAPI Generator project:
bundle add katapult-ruby
# Load the gem
require 'katapult-ruby'
# Setup authorization
KatapultAPI.configure do |config|
# Configure Bearer authorization: Authenticator
config.access_token = 'YOUR_BEARER_TOKEN'
# Configure a proc to get access tokens in lieu of the static access_token configuration
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
end
api_instance = KatapultAPI::CoreApi.new
opts = {
delete_address_list_request: KatapultAPI::DeleteAddressListRequest.new({address_list: KatapultAPI::AddressListLookup.new}) # DeleteAddressListRequest |
}
begin
result = api_instance.delete_address_list(opts)
p result
rescue KatapultAPI::ApiError => e
puts "Exception when calling CoreApi->delete_address_list: #{e}"
end
All URIs are relative to https://api.katapult.io/core/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| KatapultAPI::CoreApi | delete_address_list | DELETE /address_lists/:address_list | |
| KatapultAPI::CoreApi | delete_address_list_entry | DELETE /address_list_entries/:address_list_entry | |
| KatapultAPI::CoreApi | delete_disk_backup_policy | DELETE /disk_backup_policies/:disk_backup_policy | |
| KatapultAPI::CoreApi | delete_disk_backup_policy_schedule | DELETE /disk_backup_policies/:disk_backup_policy/schedule | |
| KatapultAPI::CoreApi | delete_dns_record | DELETE /dns_records/:dns_record | |
| KatapultAPI::CoreApi | delete_dns_zone | DELETE /dns_zones/:dns_zone | |
| KatapultAPI::CoreApi | delete_file_storage_volume | DELETE /file_storage_volumes/:file_storage_volume | |
| KatapultAPI::CoreApi | delete_ip_address | DELETE /ip_addresses/:ip_address | |
| KatapultAPI::CoreApi | delete_load_balancer | DELETE /load_balancers/:load_balancer | |
| KatapultAPI::CoreApi | delete_load_balancers_rules_load_balancer_rule | DELETE /load_balancers/rules/:load_balancer_rule | |
| KatapultAPI::CoreApi | delete_security_group | DELETE /security_groups/:security_group | |
| KatapultAPI::CoreApi | delete_security_groups_rules_security_group_rule | DELETE /security_groups/rules/:security_group_rule | |
| KatapultAPI::CoreApi | delete_ssh_key | DELETE /ssh_keys/:ssh_key | |
| KatapultAPI::CoreApi | delete_tag | DELETE /tags/:tag | |
| KatapultAPI::CoreApi | delete_trash_object | DELETE /trash_objects/:trash_object | |
| KatapultAPI::CoreApi | delete_virtual_machine | DELETE /virtual_machines/:virtual_machine | |
| KatapultAPI::CoreApi | delete_virtual_machine_group | DELETE /virtual_machine_groups/:virtual_machine_group | |
| KatapultAPI::CoreApi | get_address_list | GET /address_lists/:address_list | |
| KatapultAPI::CoreApi | get_address_list_entries | GET /address_lists/:address_list/entries | |
| KatapultAPI::CoreApi | get_address_list_entry | GET /address_list_entries/:address_list_entry | |
| KatapultAPI::CoreApi | get_address_lists | GET /address_lists | |
| KatapultAPI::CoreApi | get_certificate | GET /certificates/:certificate | |
| KatapultAPI::CoreApi | get_countries | GET /countries | |
| KatapultAPI::CoreApi | get_country | GET /countries/:country | |
| KatapultAPI::CoreApi | get_country_country_states | GET /countries/:country/country_states | |
| KatapultAPI::CoreApi | get_country_state | GET /country_states/:country_state | |
| KatapultAPI::CoreApi | get_currencies | GET /currencies | |
| KatapultAPI::CoreApi | get_currency | GET /currencies/:currency | |
| KatapultAPI::CoreApi | get_data_center | GET /data_centers/:data_center | |
| KatapultAPI::CoreApi | get_data_center_default_network | GET /data_centers/:data_center/default_network | |
| KatapultAPI::CoreApi | get_data_center_gpu_types | GET /data_centers/:data_center/gpu_types | |
| KatapultAPI::CoreApi | get_data_centers | GET /data_centers | |
| KatapultAPI::CoreApi | get_disk | GET /disks/:disk | |
| KatapultAPI::CoreApi | get_disk_backup_policy | GET /disk_backup_policies/:disk_backup_policy | |
| KatapultAPI::CoreApi | get_disk_disk_backup_policies | GET /disks/:disk/disk_backup_policies | |
| KatapultAPI::CoreApi | get_disk_template | GET /disk_templates/:disk_template | |
| KatapultAPI::CoreApi | get_disk_template_version | GET /disk_template_versions/:disk_template_version | |
| KatapultAPI::CoreApi | get_disk_template_version_spec | GET /disk_template_versions/:disk_template_version/spec | |
| KatapultAPI::CoreApi | get_disk_template_versions | GET /disk_templates/:disk_template/versions | |
| KatapultAPI::CoreApi | get_dns_record | GET /dns_records/:dns_record | |
| KatapultAPI::CoreApi | get_dns_zone | GET /dns_zones/:dns_zone | |
| KatapultAPI::CoreApi | get_dns_zone_records | GET /dns_zones/:dns_zone/records | |
| KatapultAPI::CoreApi | get_file_storage_volume | GET /file_storage_volumes/:file_storage_volume | |
| KatapultAPI::CoreApi | get_gpu_type | GET /gpu_types/:gpu_type | |
| KatapultAPI::CoreApi | get_gpu_types | GET /gpu_types | |
| KatapultAPI::CoreApi | get_ip_address | GET /ip_addresses/:ip_address | |
| KatapultAPI::CoreApi | get_load_balancer | GET /load_balancers/:load_balancer | |
| KatapultAPI::CoreApi | get_load_balancer_rules | GET /load_balancers/:load_balancer/rules | |
| KatapultAPI::CoreApi | get_load_balancers_rules_load_balancer_rule | GET /load_balancers/rules/:load_balancer_rule | |
| KatapultAPI::CoreApi | get_network | GET /networks/:network | |
| KatapultAPI::CoreApi | get_operating_system | GET /operating_systems/:operating_system | |
| KatapultAPI::CoreApi | get_operating_systems | GET /operating_systems | |
| KatapultAPI::CoreApi | get_organization | GET /organizations/:organization | |
| KatapultAPI::CoreApi | get_organization_address_lists | GET /organizations/:organization/address_lists | |
| KatapultAPI::CoreApi | get_organization_available_networks | GET /organizations/:organization/available_networks | |
| KatapultAPI::CoreApi | get_organization_certificates | GET /organizations/:organization/certificates | |
| KatapultAPI::CoreApi | get_organization_disk_backup_policies | GET /organizations/:organization/disk_backup_policies | |
| KatapultAPI::CoreApi | get_organization_disk_templates | GET /organizations/:organization/disk_templates | |
| KatapultAPI::CoreApi | get_organization_disks | GET /organizations/:organization/disks | |
| KatapultAPI::CoreApi | get_organization_dns_zones | GET /organizations/:organization/dns_zones | |
| KatapultAPI::CoreApi | get_organization_dns_zones_nameservers | GET /organizations/:organization/dns_zones/nameservers | |
| KatapultAPI::CoreApi | get_organization_file_storage_volumes | GET /organizations/:organization/file_storage_volumes | |
| KatapultAPI::CoreApi | get_organization_ip_addresses | GET /organizations/:organization/ip_addresses | |
| KatapultAPI::CoreApi | get_organization_load_balancers | GET /organizations/:organization/load_balancers | |
| KatapultAPI::CoreApi | get_organization_managed | GET /organizations/:organization/managed | |
| KatapultAPI::CoreApi | get_organization_network_speed_profiles | GET /organizations/:organization/network_speed_profiles | |
| KatapultAPI::CoreApi | get_organization_policy_limits | GET /organizations/:organization/policy_limits | |
| KatapultAPI::CoreApi | get_organization_security_groups | GET /organizations/:organization/security_groups | |
| KatapultAPI::CoreApi | get_organization_ssh_keys | GET /organizations/:organization/ssh_keys | |
| KatapultAPI::CoreApi | get_organization_tags | GET /organizations/:organization/tags | |
| KatapultAPI::CoreApi | get_organization_trash_objects | GET /organizations/:organization/trash_objects | |
| KatapultAPI::CoreApi | get_organization_users_with_access | GET /organizations/:organization/users_with_access | |
| KatapultAPI::CoreApi | get_organization_virtual_machine_groups | GET /organizations/:organization/virtual_machine_groups | |
| KatapultAPI::CoreApi | get_organization_virtual_machines | GET /organizations/:organization/virtual_machines | |
| KatapultAPI::CoreApi | get_organizations | GET /organizations | |
| KatapultAPI::CoreApi | get_security_group | GET /security_groups/:security_group | |
| KatapultAPI::CoreApi | get_security_group_rules | GET /security_groups/:security_group/rules | |
| KatapultAPI::CoreApi | get_security_groups_rules_security_group_rule | GET /security_groups/rules/:security_group_rule | |
| KatapultAPI::CoreApi | get_tag | GET /tags/:tag | |
| KatapultAPI::CoreApi | get_task | GET /tasks/:task | |
| KatapultAPI::CoreApi | get_trash_object | GET /trash_objects/:trash_object | |
| KatapultAPI::CoreApi | get_users_current | GET /users/current | |
| KatapultAPI::CoreApi | get_virtual_machine | GET /virtual_machines/:virtual_machine | |
| KatapultAPI::CoreApi | get_virtual_machine_authorized_keys | GET /virtual_machine/authorized_keys | |
| KatapultAPI::CoreApi | get_virtual_machine_disk_backup_policies | GET /virtual_machines/:virtual_machine/disk_backup_policies | |
| KatapultAPI::CoreApi | get_virtual_machine_disks | GET /virtual_machines/:virtual_machine/disks | |
| KatapultAPI::CoreApi | get_virtual_machine_group | GET /virtual_machine_groups/:virtual_machine_group | |
| KatapultAPI::CoreApi | get_virtual_machine_network_interface | GET /virtual_machines/:virtual_machine/networks/:network/interface | |
| KatapultAPI::CoreApi | get_virtual_machine_network_interface_available_ips_address_version | GET /virtual_machine_network_interfaces/:virtual_machine_network_interface/available_ips/:address_version | |
| KatapultAPI::CoreApi | get_virtual_machine_network_interfaces | GET /virtual_machines/:virtual_machine/network_interfaces | |
| KatapultAPI::CoreApi | get_virtual_machine_package | GET /virtual_machine_packages/:virtual_machine_package | |
| KatapultAPI::CoreApi | get_virtual_machine_packages | GET /virtual_machine_packages | |
| KatapultAPI::CoreApi | get_virtual_machines_builds_virtual_machine_build | GET /virtual_machines/builds/:virtual_machine_build | |
| KatapultAPI::CoreApi | get_vmnivmni | GET /virtual_machine_network_interfaces/:virtual_machine_network_interface | |
| KatapultAPI::CoreApi | get_zone | GET /zones/:zone | |
| KatapultAPI::CoreApi | get_zones | GET /zones | |
| KatapultAPI::CoreApi | patch_address_list | PATCH /address_lists/:address_list | |
| KatapultAPI::CoreApi | patch_address_list_entry | PATCH /address_list_entries/:address_list_entry | |
| KatapultAPI::CoreApi | patch_disk_backup_policy | PATCH /disk_backup_policies/:disk_backup_policy | |
| KatapultAPI::CoreApi | patch_dns_record | PATCH /dns_records/:dns_record | |
| KatapultAPI::CoreApi | patch_dns_zone | PATCH /dns_zones/:dns_zone | |
| KatapultAPI::CoreApi | patch_file_storage_volume | PATCH /file_storage_volumes/:file_storage_volume | |
| KatapultAPI::CoreApi | patch_ip_address | PATCH /ip_addresses/:ip_address | |
| KatapultAPI::CoreApi | patch_load_balancer | PATCH /load_balancers/:load_balancer | |
| KatapultAPI::CoreApi | patch_load_balancers_rules_load_balancer_rule | PATCH /load_balancers/rules/:load_balancer_rule | |
| KatapultAPI::CoreApi | patch_security_group | PATCH /security_groups/:security_group | |
| KatapultAPI::CoreApi | patch_security_groups_rules_security_group_rule | PATCH /security_groups/rules/:security_group_rule | |
| KatapultAPI::CoreApi | patch_tag | PATCH /tags/:tag | |
| KatapultAPI::CoreApi | patch_virtual_machine | PATCH /virtual_machines/:virtual_machine | |
| KatapultAPI::CoreApi | patch_virtual_machine_group | PATCH /virtual_machine_groups/:virtual_machine_group | |
| KatapultAPI::CoreApi | patch_virtual_machine_network_interface_update_speed_profile | PATCH /virtual_machine_network_interfaces/:virtual_machine_network_interface/update_speed_profile | |
| KatapultAPI::CoreApi | post_address_list_entries | POST /address_lists/:address_list/entries | |
| KatapultAPI::CoreApi | post_disk_disk_backup_policies | POST /disks/:disk/disk_backup_policies | |
| KatapultAPI::CoreApi | post_dns_zone_records | POST /dns_zones/:dns_zone/records | |
| KatapultAPI::CoreApi | post_dns_zone_verify | POST /dns_zones/:dns_zone/verify | |
| KatapultAPI::CoreApi | post_invalidate_linked_web_session | POST /invalidate_linked_web_session | |
| KatapultAPI::CoreApi | post_ip_address_unallocate | POST /ip_addresses/:ip_address/unallocate | |
| KatapultAPI::CoreApi | post_load_balancer_rules | POST /load_balancers/:load_balancer/rules | |
| KatapultAPI::CoreApi | post_organization_address_lists | POST /organizations/:organization/address_lists | |
| KatapultAPI::CoreApi | post_organization_dns_zones | POST /organizations/:organization/dns_zones | |
| KatapultAPI::CoreApi | post_organization_file_storage_volumes | POST /organizations/:organization/file_storage_volumes | |
| KatapultAPI::CoreApi | post_organization_ip_addresses | POST /organizations/:organization/ip_addresses | |
| KatapultAPI::CoreApi | post_organization_load_balancers | POST /organizations/:organization/load_balancers | |
| KatapultAPI::CoreApi | post_organization_managed | POST /organizations/:organization/managed | |
| KatapultAPI::CoreApi | post_organization_security_groups | POST /organizations/:organization/security_groups | |
| KatapultAPI::CoreApi | post_organization_ssh_keys | POST /organizations/:organization/ssh_keys | |
| KatapultAPI::CoreApi | post_organization_tags | POST /organizations/:organization/tags | |
| KatapultAPI::CoreApi | post_organization_trash_objects_purge_all | POST /organizations/:organization/trash_objects/purge_all | |
| KatapultAPI::CoreApi | post_organization_virtual_machine_groups | POST /organizations/:organization/virtual_machine_groups | |
| KatapultAPI::CoreApi | post_organization_virtual_machines_build | POST /organizations/:organization/virtual_machines/build | |
| KatapultAPI::CoreApi | post_organization_virtual_machines_build_from_spec | POST /organizations/:organization/virtual_machines/build_from_spec | |
| KatapultAPI::CoreApi | post_security_group_rules | POST /security_groups/:security_group/rules | |
| KatapultAPI::CoreApi | post_trash_object_restore | POST /trash_objects/:trash_object/restore | |
| KatapultAPI::CoreApi | post_virtual_machine_allocate_ip | POST /virtual_machines/:virtual_machine/allocate_ip | |
| KatapultAPI::CoreApi | post_virtual_machine_console_sessions | POST /virtual_machines/:virtual_machine/console_sessions | |
| KatapultAPI::CoreApi | post_virtual_machine_disk_backup_policies | POST /virtual_machines/:virtual_machine/disk_backup_policies | |
| KatapultAPI::CoreApi | post_virtual_machine_network_interface_allocate_ip | POST /virtual_machine_network_interfaces/:virtual_machine_network_interface/allocate_ip | |
| KatapultAPI::CoreApi | post_virtual_machine_network_interface_allocate_new_ip | POST /virtual_machine_network_interfaces/:virtual_machine_network_interface/allocate_new_ip | |
| KatapultAPI::CoreApi | post_virtual_machine_reset | POST /virtual_machines/:virtual_machine/reset | |
| KatapultAPI::CoreApi | post_virtual_machine_shutdown | POST /virtual_machines/:virtual_machine/shutdown | |
| KatapultAPI::CoreApi | post_virtual_machine_start | POST /virtual_machines/:virtual_machine/start | |
| KatapultAPI::CoreApi | post_virtual_machine_stop | POST /virtual_machines/:virtual_machine/stop | |
| KatapultAPI::CoreApi | put_virtual_machine_flexible_resources | PUT /virtual_machines/:virtual_machine/flexible_resources | |
| KatapultAPI::CoreApi | put_virtual_machine_package | PUT /virtual_machines/:virtual_machine/package |
Authentication schemes defined for the API:
FAQs
Unknown package
We found that katapult-ruby demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.
Security News
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.