API Reference

Katapult Core API

Resources & Endpoints

Update the network speed profile for a virtual machine network interface

PATCH
https://api.katapult.io/core/v1/virtual_machine_network_interfaces/{virtual_machine_network_interface}/update_speed_profile

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

virtual_machine_network_interface Required

The network interface to update

 Virtual Machine Network Interface Lookup None

speed_profile Required

The network speed profile to assign to this virtual machine network interface

 Network Speed Profile Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

network_speed_profile_not_found

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

 404 Not Found

speed_profile_already_assigned

This network speed profile is already assigned to this virtual machine network interface.

 422 Unprocessable Entity

task_queueing_error

This error means that a background task that was needed to complete your request could not be queued

 406 Not Acceptable

virtual_machine_network_interface_not_found

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

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    task: Task {
        id: String
        name: String
        status: TaskStatusEnum
        created_at: Unix Timestamp
        started_at: Unix Timestamp?
        finished_at: Unix Timestamp?
        progress: Integer
    }
}