🚀 Socket Launch Week 🚀 Day 3: Socket Acquires Coana.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

katapult-ruby

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

katapult-ruby

0.0.6
Rubygems
Version published
Maintainers
1
Created
Source

katapult-ruby

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:

  • API version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

bundle add katapult-ruby

Getting Started

# 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

Documentation for API Endpoints

All URIs are relative to https://api.katapult.io/core/v1

ClassMethodHTTP requestDescription
KatapultAPI::CoreApidelete_address_listDELETE /address_lists/:address_list
KatapultAPI::CoreApidelete_address_list_entryDELETE /address_list_entries/:address_list_entry
KatapultAPI::CoreApidelete_disk_backup_policyDELETE /disk_backup_policies/:disk_backup_policy
KatapultAPI::CoreApidelete_disk_backup_policy_scheduleDELETE /disk_backup_policies/:disk_backup_policy/schedule
KatapultAPI::CoreApidelete_dns_recordDELETE /dns_records/:dns_record
KatapultAPI::CoreApidelete_dns_zoneDELETE /dns_zones/:dns_zone
KatapultAPI::CoreApidelete_file_storage_volumeDELETE /file_storage_volumes/:file_storage_volume
KatapultAPI::CoreApidelete_ip_addressDELETE /ip_addresses/:ip_address
KatapultAPI::CoreApidelete_load_balancerDELETE /load_balancers/:load_balancer
KatapultAPI::CoreApidelete_load_balancers_rules_load_balancer_ruleDELETE /load_balancers/rules/:load_balancer_rule
KatapultAPI::CoreApidelete_security_groupDELETE /security_groups/:security_group
KatapultAPI::CoreApidelete_security_groups_rules_security_group_ruleDELETE /security_groups/rules/:security_group_rule
KatapultAPI::CoreApidelete_ssh_keyDELETE /ssh_keys/:ssh_key
KatapultAPI::CoreApidelete_tagDELETE /tags/:tag
KatapultAPI::CoreApidelete_trash_objectDELETE /trash_objects/:trash_object
KatapultAPI::CoreApidelete_virtual_machineDELETE /virtual_machines/:virtual_machine
KatapultAPI::CoreApidelete_virtual_machine_groupDELETE /virtual_machine_groups/:virtual_machine_group
KatapultAPI::CoreApiget_address_listGET /address_lists/:address_list
KatapultAPI::CoreApiget_address_list_entriesGET /address_lists/:address_list/entries
KatapultAPI::CoreApiget_address_list_entryGET /address_list_entries/:address_list_entry
KatapultAPI::CoreApiget_address_listsGET /address_lists
KatapultAPI::CoreApiget_certificateGET /certificates/:certificate
KatapultAPI::CoreApiget_countriesGET /countries
KatapultAPI::CoreApiget_countryGET /countries/:country
KatapultAPI::CoreApiget_country_country_statesGET /countries/:country/country_states
KatapultAPI::CoreApiget_country_stateGET /country_states/:country_state
KatapultAPI::CoreApiget_currenciesGET /currencies
KatapultAPI::CoreApiget_currencyGET /currencies/:currency
KatapultAPI::CoreApiget_data_centerGET /data_centers/:data_center
KatapultAPI::CoreApiget_data_center_default_networkGET /data_centers/:data_center/default_network
KatapultAPI::CoreApiget_data_center_gpu_typesGET /data_centers/:data_center/gpu_types
KatapultAPI::CoreApiget_data_centersGET /data_centers
KatapultAPI::CoreApiget_diskGET /disks/:disk
KatapultAPI::CoreApiget_disk_backup_policyGET /disk_backup_policies/:disk_backup_policy
KatapultAPI::CoreApiget_disk_disk_backup_policiesGET /disks/:disk/disk_backup_policies
KatapultAPI::CoreApiget_disk_templateGET /disk_templates/:disk_template
KatapultAPI::CoreApiget_disk_template_versionGET /disk_template_versions/:disk_template_version
KatapultAPI::CoreApiget_disk_template_version_specGET /disk_template_versions/:disk_template_version/spec
KatapultAPI::CoreApiget_disk_template_versionsGET /disk_templates/:disk_template/versions
KatapultAPI::CoreApiget_dns_recordGET /dns_records/:dns_record
KatapultAPI::CoreApiget_dns_zoneGET /dns_zones/:dns_zone
KatapultAPI::CoreApiget_dns_zone_recordsGET /dns_zones/:dns_zone/records
KatapultAPI::CoreApiget_file_storage_volumeGET /file_storage_volumes/:file_storage_volume
KatapultAPI::CoreApiget_gpu_typeGET /gpu_types/:gpu_type
KatapultAPI::CoreApiget_gpu_typesGET /gpu_types
KatapultAPI::CoreApiget_ip_addressGET /ip_addresses/:ip_address
KatapultAPI::CoreApiget_load_balancerGET /load_balancers/:load_balancer
KatapultAPI::CoreApiget_load_balancer_rulesGET /load_balancers/:load_balancer/rules
KatapultAPI::CoreApiget_load_balancers_rules_load_balancer_ruleGET /load_balancers/rules/:load_balancer_rule
KatapultAPI::CoreApiget_networkGET /networks/:network
KatapultAPI::CoreApiget_operating_systemGET /operating_systems/:operating_system
KatapultAPI::CoreApiget_operating_systemsGET /operating_systems
KatapultAPI::CoreApiget_organizationGET /organizations/:organization
KatapultAPI::CoreApiget_organization_address_listsGET /organizations/:organization/address_lists
KatapultAPI::CoreApiget_organization_available_networksGET /organizations/:organization/available_networks
KatapultAPI::CoreApiget_organization_certificatesGET /organizations/:organization/certificates
KatapultAPI::CoreApiget_organization_disk_backup_policiesGET /organizations/:organization/disk_backup_policies
KatapultAPI::CoreApiget_organization_disk_templatesGET /organizations/:organization/disk_templates
KatapultAPI::CoreApiget_organization_disksGET /organizations/:organization/disks
KatapultAPI::CoreApiget_organization_dns_zonesGET /organizations/:organization/dns_zones
KatapultAPI::CoreApiget_organization_dns_zones_nameserversGET /organizations/:organization/dns_zones/nameservers
KatapultAPI::CoreApiget_organization_file_storage_volumesGET /organizations/:organization/file_storage_volumes
KatapultAPI::CoreApiget_organization_ip_addressesGET /organizations/:organization/ip_addresses
KatapultAPI::CoreApiget_organization_load_balancersGET /organizations/:organization/load_balancers
KatapultAPI::CoreApiget_organization_managedGET /organizations/:organization/managed
KatapultAPI::CoreApiget_organization_network_speed_profilesGET /organizations/:organization/network_speed_profiles
KatapultAPI::CoreApiget_organization_policy_limitsGET /organizations/:organization/policy_limits
KatapultAPI::CoreApiget_organization_security_groupsGET /organizations/:organization/security_groups
KatapultAPI::CoreApiget_organization_ssh_keysGET /organizations/:organization/ssh_keys
KatapultAPI::CoreApiget_organization_tagsGET /organizations/:organization/tags
KatapultAPI::CoreApiget_organization_trash_objectsGET /organizations/:organization/trash_objects
KatapultAPI::CoreApiget_organization_users_with_accessGET /organizations/:organization/users_with_access
KatapultAPI::CoreApiget_organization_virtual_machine_groupsGET /organizations/:organization/virtual_machine_groups
KatapultAPI::CoreApiget_organization_virtual_machinesGET /organizations/:organization/virtual_machines
KatapultAPI::CoreApiget_organizationsGET /organizations
KatapultAPI::CoreApiget_security_groupGET /security_groups/:security_group
KatapultAPI::CoreApiget_security_group_rulesGET /security_groups/:security_group/rules
KatapultAPI::CoreApiget_security_groups_rules_security_group_ruleGET /security_groups/rules/:security_group_rule
KatapultAPI::CoreApiget_tagGET /tags/:tag
KatapultAPI::CoreApiget_taskGET /tasks/:task
KatapultAPI::CoreApiget_trash_objectGET /trash_objects/:trash_object
KatapultAPI::CoreApiget_users_currentGET /users/current
KatapultAPI::CoreApiget_virtual_machineGET /virtual_machines/:virtual_machine
KatapultAPI::CoreApiget_virtual_machine_authorized_keysGET /virtual_machine/authorized_keys
KatapultAPI::CoreApiget_virtual_machine_disk_backup_policiesGET /virtual_machines/:virtual_machine/disk_backup_policies
KatapultAPI::CoreApiget_virtual_machine_disksGET /virtual_machines/:virtual_machine/disks
KatapultAPI::CoreApiget_virtual_machine_groupGET /virtual_machine_groups/:virtual_machine_group
KatapultAPI::CoreApiget_virtual_machine_network_interfaceGET /virtual_machines/:virtual_machine/networks/:network/interface
KatapultAPI::CoreApiget_virtual_machine_network_interface_available_ips_address_versionGET /virtual_machine_network_interfaces/:virtual_machine_network_interface/available_ips/:address_version
KatapultAPI::CoreApiget_virtual_machine_network_interfacesGET /virtual_machines/:virtual_machine/network_interfaces
KatapultAPI::CoreApiget_virtual_machine_packageGET /virtual_machine_packages/:virtual_machine_package
KatapultAPI::CoreApiget_virtual_machine_packagesGET /virtual_machine_packages
KatapultAPI::CoreApiget_virtual_machines_builds_virtual_machine_buildGET /virtual_machines/builds/:virtual_machine_build
KatapultAPI::CoreApiget_vmnivmniGET /virtual_machine_network_interfaces/:virtual_machine_network_interface
KatapultAPI::CoreApiget_zoneGET /zones/:zone
KatapultAPI::CoreApiget_zonesGET /zones
KatapultAPI::CoreApipatch_address_listPATCH /address_lists/:address_list
KatapultAPI::CoreApipatch_address_list_entryPATCH /address_list_entries/:address_list_entry
KatapultAPI::CoreApipatch_disk_backup_policyPATCH /disk_backup_policies/:disk_backup_policy
KatapultAPI::CoreApipatch_dns_recordPATCH /dns_records/:dns_record
KatapultAPI::CoreApipatch_dns_zonePATCH /dns_zones/:dns_zone
KatapultAPI::CoreApipatch_file_storage_volumePATCH /file_storage_volumes/:file_storage_volume
KatapultAPI::CoreApipatch_ip_addressPATCH /ip_addresses/:ip_address
KatapultAPI::CoreApipatch_load_balancerPATCH /load_balancers/:load_balancer
KatapultAPI::CoreApipatch_load_balancers_rules_load_balancer_rulePATCH /load_balancers/rules/:load_balancer_rule
KatapultAPI::CoreApipatch_security_groupPATCH /security_groups/:security_group
KatapultAPI::CoreApipatch_security_groups_rules_security_group_rulePATCH /security_groups/rules/:security_group_rule
KatapultAPI::CoreApipatch_tagPATCH /tags/:tag
KatapultAPI::CoreApipatch_virtual_machinePATCH /virtual_machines/:virtual_machine
KatapultAPI::CoreApipatch_virtual_machine_groupPATCH /virtual_machine_groups/:virtual_machine_group
KatapultAPI::CoreApipatch_virtual_machine_network_interface_update_speed_profilePATCH /virtual_machine_network_interfaces/:virtual_machine_network_interface/update_speed_profile
KatapultAPI::CoreApipost_address_list_entriesPOST /address_lists/:address_list/entries
KatapultAPI::CoreApipost_disk_disk_backup_policiesPOST /disks/:disk/disk_backup_policies
KatapultAPI::CoreApipost_dns_zone_recordsPOST /dns_zones/:dns_zone/records
KatapultAPI::CoreApipost_dns_zone_verifyPOST /dns_zones/:dns_zone/verify
KatapultAPI::CoreApipost_invalidate_linked_web_sessionPOST /invalidate_linked_web_session
KatapultAPI::CoreApipost_ip_address_unallocatePOST /ip_addresses/:ip_address/unallocate
KatapultAPI::CoreApipost_load_balancer_rulesPOST /load_balancers/:load_balancer/rules
KatapultAPI::CoreApipost_organization_address_listsPOST /organizations/:organization/address_lists
KatapultAPI::CoreApipost_organization_dns_zonesPOST /organizations/:organization/dns_zones
KatapultAPI::CoreApipost_organization_file_storage_volumesPOST /organizations/:organization/file_storage_volumes
KatapultAPI::CoreApipost_organization_ip_addressesPOST /organizations/:organization/ip_addresses
KatapultAPI::CoreApipost_organization_load_balancersPOST /organizations/:organization/load_balancers
KatapultAPI::CoreApipost_organization_managedPOST /organizations/:organization/managed
KatapultAPI::CoreApipost_organization_security_groupsPOST /organizations/:organization/security_groups
KatapultAPI::CoreApipost_organization_ssh_keysPOST /organizations/:organization/ssh_keys
KatapultAPI::CoreApipost_organization_tagsPOST /organizations/:organization/tags
KatapultAPI::CoreApipost_organization_trash_objects_purge_allPOST /organizations/:organization/trash_objects/purge_all
KatapultAPI::CoreApipost_organization_virtual_machine_groupsPOST /organizations/:organization/virtual_machine_groups
KatapultAPI::CoreApipost_organization_virtual_machines_buildPOST /organizations/:organization/virtual_machines/build
KatapultAPI::CoreApipost_organization_virtual_machines_build_from_specPOST /organizations/:organization/virtual_machines/build_from_spec
KatapultAPI::CoreApipost_security_group_rulesPOST /security_groups/:security_group/rules
KatapultAPI::CoreApipost_trash_object_restorePOST /trash_objects/:trash_object/restore
KatapultAPI::CoreApipost_virtual_machine_allocate_ipPOST /virtual_machines/:virtual_machine/allocate_ip
KatapultAPI::CoreApipost_virtual_machine_console_sessionsPOST /virtual_machines/:virtual_machine/console_sessions
KatapultAPI::CoreApipost_virtual_machine_disk_backup_policiesPOST /virtual_machines/:virtual_machine/disk_backup_policies
KatapultAPI::CoreApipost_virtual_machine_network_interface_allocate_ipPOST /virtual_machine_network_interfaces/:virtual_machine_network_interface/allocate_ip
KatapultAPI::CoreApipost_virtual_machine_network_interface_allocate_new_ipPOST /virtual_machine_network_interfaces/:virtual_machine_network_interface/allocate_new_ip
KatapultAPI::CoreApipost_virtual_machine_resetPOST /virtual_machines/:virtual_machine/reset
KatapultAPI::CoreApipost_virtual_machine_shutdownPOST /virtual_machines/:virtual_machine/shutdown
KatapultAPI::CoreApipost_virtual_machine_startPOST /virtual_machines/:virtual_machine/start
KatapultAPI::CoreApipost_virtual_machine_stopPOST /virtual_machines/:virtual_machine/stop
KatapultAPI::CoreApiput_virtual_machine_flexible_resourcesPUT /virtual_machines/:virtual_machine/flexible_resources
KatapultAPI::CoreApiput_virtual_machine_packagePUT /virtual_machines/:virtual_machine/package

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

Authenticator

  • Type: Bearer authentication

FAQs

Package last updated on 27 Jun 2024

Did you know?

Socket

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.

Install

Related posts

Introducing Module Reachability: Focus on the Vulnerabilities That Matter

Product

Introducing Module Reachability: Focus on the Vulnerabilities That Matter

Module Reachability filters out unreachable CVEs so you can focus on vulnerabilities that actually matter to your application.

By Trevor Norris  -  Apr 23, 2025