Skip to main content

Update load balancer

PATCH 

/load_balancers/load_balancer

Updates a load balancer with new properties

Scopes

  • load_balancers

OAuth2 Scopes

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

Request

Body

    load_balancer

    object

    required

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

    id string
    api_reference string

    properties

    object

    required

    name string
    api_reference string
    resource_type LoadBalancerResourceTypesEnum (string)

    Possible values: [virtual_machines, virtual_machine_groups, tags]

    resource_ids string[]

    data_center

    object

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

    id string
    permalink string
    https_redirect boolean
    enable_weighting boolean

    weights

    object[]

  • Array [

  • virtual_machine_id string
    weight integer
  • ]

  • standby_vms string[]

    annotations

    object[]

  • Array [

  • key stringrequired
    value string
  • ]

Responses

Updates a load balancer with new properties

Schema

    load_balancer

    object

    required

    id string
    name string
    api_reference stringnullable
    resource_type LoadBalancerResourceTypesEnum (string)

    Possible values: [virtual_machines, virtual_machine_groups, tags]

    resources

    object[]

  • Array [

  • resources

    object

    oneOf

    id string
    name string
    hostname string
    fqdn string
    description stringnullable
    created_at integer
    initial_root_password stringnullable
    state VirtualMachineStateEnum (string)

    Possible values: [stopped, failed, started, starting, allocated, allocating, resetting, migrating, stopping, shutting_down, transferring, orphaned]

    zone

    object

    id string
    name string
    permalink stringnullable

    data_center

    object

    id string
    name string
    permalink string

    country

    object

    id string
    name string
    iso_code2 string
    iso_code3 string
    time_zone stringnullable
    eu boolean

    organization

    object

    id string
    name string
    sub_domain string
    infrastructure_domain string
    created_at integer
    activated_at integernullable
    suspended boolean
    managed boolean
    billing_name stringnullable
    address1 stringnullable
    address2 stringnullable
    address3 stringnullable
    address4 stringnullable
    postcode stringnullable
    vat_number stringnullable
    phone_number stringnullable

    currency

    object

    id string
    name string
    iso_code string
    symbol string

    country

    object

    nullable

    id string
    name string
    iso_code2 string
    iso_code3 string
    time_zone stringnullable
    eu boolean

    country_state

    object

    nullable

    id string
    name string
    code string

    country

    object

    id string
    name string
    iso_code2 string
    iso_code3 string
    time_zone stringnullable
    eu boolean

    group

    object

    nullable

    id string
    name string
    segregate boolean
    auto_segregate boolean
    created_at integer

    package

    object

    nullable

    id string
    name string
    permalink string
    cpu_cores integer
    ipv4_addresses integer
    memory_in_gb integer
    storage_in_gb integer
    monthly_bandwidth_allowance_in_gb integernullable
    privacy PrivacyTypesEnum (string)

    Possible values: [public, private]

    icon

    object

    nullable

    url string
    file_name string
    file_type string
    file_size integer
    digest string
    token string
    use_dedicated_cpus boolean

    group

    object

    id string
    name string

    attached_iso

    object

    nullable

    id string
    name string

    operating_system

    object

    nullable

    id string
    name string

    badge

    object

    nullable

    url string
    file_name string
    file_type string
    file_size integer
    digest string
    token string
    memory_in_gb integernullable
    cpu_cores integernullable
    use_dedicated_cpus booleannullable

    gpu_type

    object

    nullable

    id string
    name string
    manufacturer string
    memory_in_gb integer
    memory_type string
    permalink string

    data_centers

    object[]

  • Array [

  • id string
    name string
    permalink string

    country

    object

    id string
    name string
    iso_code2 string
    iso_code3 string
    time_zone stringnullable
    eu boolean
  • ]

  • gpus

    object[]

  • Array [

  • id stringnullable

    Unique ID for this GPU. Not available when status is "detached".

    status VirtualMachineGPUStatusEnum (string)

    Possible values: [attached, attaching, detached, detaching, unknown]

    pending_action VirtualMachineGPUPendingActionEnum (string)nullable

    Possible values: [attach, detach]

    available boolean

    When pending action is "attach", this indicates if there is a GPU of the relevant type available.

    type

    object

    id string
    name string
    manufacturer string
    memory_in_gb integer
    memory_type string
    permalink string

    data_centers

    object[]

  • Array [

  • id string
    name string
    permalink string

    country

    object

    id string
    name string
    iso_code2 string
    iso_code3 string
    time_zone stringnullable
    eu boolean
  • ]

  • ]

  • tags

    object[]

  • Array [

  • id string
    name string
    color TagColorsEnum (string)

    Possible values: [red, pink, purple, dark_blue, green, teal, aqua, light_blue, yellow, orange, orange_red, brown, black, dark_gray, light_gray, light_brown, pastel_red, pastel_pink, pastel_purple, pastel_dark_blue, pastel_green, pastel_teal, pastel_aqua, pastel_light_blue, pastel_yellow, pastel_orange, pastel_orange_red, pastel_brown, pastel_black, pastel_dark_gray, pastel_light_gray, pastel_light_brown]

    created_at integer
  • ]

  • tag_names string[]

    ip_addresses

    object[]

  • Array [

  • id string
    address string
    reverse_dns string
    vip boolean
    label stringnullable
    address_with_mask string

    network

    object

    id string
    name string
    permalink stringnullable

    data_center

    object

    id string
    name string
    permalink string

    country

    object

    id string
    name string
    iso_code2 string
    iso_code3 string
    time_zone stringnullable
    eu boolean
    allocation_id stringnullable
    allocation_type stringnullable
  • ]

  • hypervisor

    object

    nullable

    id string
    name string
    ip_address string
  • ]

  • resource_ids string[]

    ip_address

    object

    id string
    address string
    https_redirect boolean
    backend_certificate string
    backend_certificate_key string

    data_center

    object

    id string
    name string
    permalink string
    enable_weighting boolean

    weights

    object[]

  • Array [

  • virtual_machine_id string
    weight integer
  • ]

  • standby_vms string[]

    annotations

    object[]

    required

  • Array [

  • key stringrequired
    value string
  • ]

Loading...