Log in Sign up
APIsCloudDelete organization API tokenUpdate organization API tokenRegenerate organization API token secretList organization API tokensCreate API token for organizationDelete address list entryGet address list entryUpdate address list entryList global address listsDelete address listGet address listUpdate address listList address list entriesCreate address list entryBulk change address list entriesList address listsCreate address listDelete certificateGet certificateRe-issue certificateReset certificate API tokenList certificatesCreate certificateDelete a container registry artifactGet container registry artifact detailsList container registry regionsDelete container registry repositoryList container registry artifactsList container registry repositoriesList countriesGet countryList country statesGet country stateList currenciesGet currencyDelete DNS recordGet DNS recordUpdate DNS recordDelete DNS zoneGet DNS zoneUpdate DNS zoneList DNS recordsCreate DNS recordVerify DNS zoneList DNS zonesCreate DNS zoneList nameserversList data centersGet data centerGet default network of data centerList disk IO profilesDelete disk backup policyGet disk backup policyUpdate a disk backup policySchedule delete disk backup policyList disk backup policies for diskCreate disk backup policy for diskList disk backup policiesCreate disk backup policy for organizationList disk backup policies for virtual machineCreate disk backup policy for Virtual MachineGet disk template versionGet disk template version specList disk template versionsGet disk templateList disk templatesDelete diskGet diskUpdate diskAssign disk to virtual machineAttach disk to virtual machineDetach disk from virtual machineChange disk IO profileResize diskUnassign disk from virtual machineList disksCreate diskList virtual machine disksDelete file storage volumeGet file storage volumeUpdate file storage volumeList file storage volumesCreate file storage volumeList GPU types for Data CenterList GPU typesGet GPU typeRelease an IP addressGet IP addressUpdate IP addressUnallocate an IP addressList IP addressesCreate IP AddressDelete load balancerGet load balancerUpdate load balancerList load balancer rulesCreate load balancer ruleDelete load balancer ruleGet load balancer ruleUpdate load balancer ruleList load balancersCreate load balancerList network speed profilesGet NetworkList networksDelete object storage access keyGet object storage access key detailsUpdate object storage access keyGenerate object storage S3 access key credentialsDelete object storage bucketGet an object storage bucketUpdate object storage bucketGet an object storage objectCreate a presigned url for an object storage objectRevoke object storage bucket presigned URLsList object storage access keysMove object storage to trashGet object storage account detailsCreate object storage accountCreate object storage access keyCreate object storage bucketList operating systemsGet operating systemDelete managed organizationUpdate managed organizationsList organizationsGet organizationDeletion stepsList managed organizationsCreate managed organizationGet organization limits and usageGet organization policy limitsGet organization pricesList organization usersList organization SSH keysAdd organization SSH keyDelete SSH keyList security groupsCreate security groupDelete security group ruleGet security group ruleUpdate security group ruleDelete security groupGet security groupUpdate security groupList security group rulesCreate security group ruleList tagsCreate a tagDelete a tagGet tagUpdate a tagGet TaskList trash objectsPurge all trash objectsPurge a trash objectGet trash objectRestore a trash objectGet current user detailsList virtual networksCreate a virtual networkDelete a virtual networkGet virtual networkUpdate a virtual networkList virtual machine groupsCreate a virtual machine groupDelete a virtual machine groupGet virtual machine groupUpdate a virtual machine groupDelete a virtual machine network interfaceGet virtual machine network interfaceAllocate an IP addressAllocate a new IP addressAttach to virtual machineGet addresses available for network interfaceDetach from virtual machineUpdate the network speed profile for a virtual machine network interfaceList virtual machine network interfacesCreate a virtual network interfaceGet virtual machine network interface by networkList virtual machine packagesGet virtual machine packageList virtual machinesBuild virtual machineBuild virtual machine (from spec)Get authorized keys for a virtual machineGet virtual machine buildDelete virtual machineGet virtual machineUpdate a Virtual MachineAllocate an IP AddressCreate console sessionChange flexible resourcesChange packageReset virtual machineShutdown virtual machineStart virtual machineStop virtual machineList zonesGet zone
Get addresses available for network interface APIs Cloud Get addresses available for network interface Search docs / Returns a list of IP addresses that can be allocated to a specific network interface
GET https://api.katapult.io/core/v1/virtual_machine_network_interfaces/virtual_machine_network_interface/available_ips/address_version
Details Success status 200 OK Required scopes ip_addresses ip_addresses:read

Possible errors

Code Error When it happens
400 missing_api_token No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer
403 unauthorized_network_for_api_token Network is not allowed to access the API with this API token
403 invalid_api_token The API token provided was not valid (it may not exist or have expired)
403 token_owner_suspended The user that owns the API token has been suspended
403 invalid_capabilities_token The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)
403 scope_not_granted The scope required for this endpoint has not been granted to the authenticating identity
404 virtual_machine_network_interface_not_found No network interface was found matching any of the criteria provided in the arguments
429 rate_limit_reached You have reached the rate limit for this type of request
503 service_unavailable The service is currently unavailable, please try again later
Arguments
  • virtual_machine_network_interface[id] string query

    The network interface to get IP addresses for.

  • address_version string required query

    The IP address version to return results for

    Allowed values: ipv4ipv6

Response
  • ip_addresses array

    The IP addresses available for this network interface

    • id string
    • address string
    • reverse_dns string
    • vip boolean
    • label string
    • address_with_mask string
    • network object
      • id string
      • name string
      • permalink string
      • default boolean

        Indicates if this network is the default network for the data center.

      • data_center object
        • id string
        • name string
        • permalink string
        • country object
          • id string
          • name string
          • iso_code2 string
          • iso_code3 string
          • time_zone string
          • eu boolean
      • vlan integer

        The underlying VLAN ID given to this network. Internal use only.

    • subnet object
      • id string
      • address string
      • gateway string
      • mask integer
      • billable boolean
      • version integer
    • allocation_id string
    • allocation_type string

Example response

{
  "ip_addresses": [
    {
      "id": "string",
      "address": "string",
      "reverse_dns": "string",
      "vip": true,
      "label": "string",
      "address_with_mask": "string",
      "network": {
        "id": "string",
        "name": "string",
        "permalink": "string",
        "default": true,
        "data_center": {
          "id": "string",
          "name": "string",
          "permalink": "string",
          "country": {
            "id": "string",
            "name": "string",
            "iso_code2": "string",
            "iso_code3": "string",
            "time_zone": "string",
            "eu": true
          }
        },
        "vlan": 0
      },
      "subnet": {
        "id": "string",
        "address": "string",
        "gateway": "string",
        "mask": 0,
        "billable": true,
        "version": 0
      },
      "allocation_id": "string",
      "allocation_type": "string"
    }
  ]
}
 Try it
Requests are real Executing sends a live GET request to https://api.katapult.io/core/v1 from your browser. There is no sandbox — the call hits whichever environment your token belongs to, and any change it makes is a real change.
Token

Sent to https://api.katapult.io/core/v1 as a bearer token and never to Krystal Documentation. It isn't stored anywhere, so paste it again on each endpoint page.

API token
Query parameters

Left blank, a parameter is omitted from the request.

The network interface to get IP addresses for. virtual_machine_network_interface[id] The IP address version to return results for address_version
Execute Copy as curl
Navigate Select Esc to close