Get virtual machine network interface by network

GET 
/virtual_machines/virtual_machine/networks/network/interface

Return information about a virtual machine network interface for a specific network

Scopes

• virtual_machines
• virtual_machines:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

virtual_machine[id] string

The virtual machine to find the network interface for.

All 'virtual_machine[]' params are mutually exclusive, only one can be provided.

virtual_machine[fqdn] string

The virtual machine to find the network interface for.

All 'virtual_machine[]' params are mutually exclusive, only one can be provided.

network[id] string

The network to find the network interface for.

All 'network[]' params are mutually exclusive, only one can be provided.

network[permalink] string

The network to find the network interface for.

All 'network[]' params are mutually exclusive, only one can be provided.

Responses

200

Return information about a virtual machine network interface for a specific network

application/json

Schema

Schema

virtual_machine_network_interface

object

required

id string

virtual_machine

object

id string

name string

name string

network

object

nullable

id string

name string

virtual_network

object

nullable

id string

name string

mac_address string

state string

ip_addresses

object[]

Array [

id string

address string

]

Example (from schema)

{
  "virtual_machine_network_interface": {
    "id": "string",
    "virtual_machine": {
      "id": "string",
      "name": "string"
    },
    "name": "string",
    "network": {
      "id": "string",
      "name": "string"
    },
    "virtual_network": {
      "id": "string",
      "name": "string"
    },
    "mac_address": "string",
    "state": "string",
    "ip_addresses": [
      {
        "id": "string",
        "address": "string"
      }
    ]
  }
}

400

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

application/json

Schema

Schema

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string
detail object

Example (from schema)

{
  "code": "missing_api_token",
  "description": "string",
  "detail": {}
}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

Example (from schema)

{}

404

404 error response

application/json

Schema

Schema

oneOf

VirtualMachineNotFoundSchema

No virtual machine was found matching any of the criteria provided in the arguments

code VirtualMachineNotFoundEnum (string)

Possible values: [virtual_machine_not_found]

description string

detail object

NetworkNotFoundSchema

No network was found matching any of the criteria provided in the arguments

code NetworkNotFoundEnum (string)

Possible values: [network_not_found]

description string

detail object

InterfaceNotFoundSchema

An interface could not be found for the specified network

code InterfaceNotFoundEnum (string)

Possible values: [interface_not_found]

description string

detail object

Example (from schema)

{}

406

The object found is in the trash and therefore cannot be manipulated through the API. It should be restored in order to run this operation.

application/json

Schema

Schema

code ObjectInTrashEnum (string)

Possible values: [object_in_trash]

description string

detail

object

trash_object

object

nullable

id string

keep_until integer

object_id string

object_type string

Example (from schema)

{
  "code": "object_in_trash",
  "description": "string",
  "detail": {
    "trash_object": {
      "id": "string",
      "keep_until": 0,
      "object_id": "string",
      "object_type": "string"
    }
  }
}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...