Create load balancer

POST 
/organizations/organization/load_balancers

Create a new load balancer for a given organization

Scopes

• load_balancers

OAuth2 Scopes

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

Request

application/json

Body

organization

object

required

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

id string

sub_domain 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

201

Create a new load balancer for a given organization

application/json

Schema

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

VirtualMachine

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

VirtualMachineGroup

id string

name string

segregate boolean

auto_segregate boolean

created_at integer

Tag

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

]

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

]

Example (from schema)

{
  "load_balancer": {
    "id": "string",
    "name": "string",
    "api_reference": "string",
    "resource_type": "virtual_machines",
    "resources": [
      {
        "resources": {
          "id": "string",
          "name": "string",
          "hostname": "string",
          "fqdn": "string",
          "description": "string",
          "created_at": 0,
          "initial_root_password": "string",
          "state": "stopped",
          "zone": {
            "id": "string",
            "name": "string",
            "permalink": "string",
            "data_center": {
              "id": "string",
              "name": "string",
              "permalink": "string",
              "country": {
                "id": "string",
                "name": "string",
                "iso_code2": "string",
                "iso_code3": "string",
                "time_zone": "string",
                "eu": true
              }
            }
          },
          "organization": {
            "id": "string",
            "name": "string",
            "sub_domain": "string",
            "infrastructure_domain": "string",
            "created_at": 0,
            "activated_at": 0,
            "suspended": true,
            "managed": true,
            "billing_name": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "address4": "string",
            "postcode": "string",
            "vat_number": "string",
            "phone_number": "string",
            "currency": {
              "id": "string",
              "name": "string",
              "iso_code": "string",
              "symbol": "string"
            },
            "country": {
              "id": "string",
              "name": "string",
              "iso_code2": "string",
              "iso_code3": "string",
              "time_zone": "string",
              "eu": true
            },
            "country_state": {
              "id": "string",
              "name": "string",
              "code": "string",
              "country": {
                "id": "string",
                "name": "string",
                "iso_code2": "string",
                "iso_code3": "string",
                "time_zone": "string",
                "eu": true
              }
            }
          },
          "group": {
            "id": "string",
            "name": "string",
            "segregate": true,
            "auto_segregate": true,
            "created_at": 0
          },
          "package": {
            "id": "string",
            "name": "string",
            "permalink": "string",
            "cpu_cores": 0,
            "ipv4_addresses": 0,
            "memory_in_gb": 0,
            "storage_in_gb": 0,
            "monthly_bandwidth_allowance_in_gb": 0,
            "privacy": "public",
            "icon": {
              "url": "string",
              "file_name": "string",
              "file_type": "string",
              "file_size": 0,
              "digest": "string",
              "token": "string"
            },
            "use_dedicated_cpus": true,
            "group": {
              "id": "string",
              "name": "string"
            }
          },
          "attached_iso": {
            "id": "string",
            "name": "string",
            "operating_system": {
              "id": "string",
              "name": "string",
              "badge": {
                "url": "string",
                "file_name": "string",
                "file_type": "string",
                "file_size": 0,
                "digest": "string",
                "token": "string"
              }
            }
          },
          "memory_in_gb": 0,
          "cpu_cores": 0,
          "use_dedicated_cpus": true,
          "gpu_type": {
            "id": "string",
            "name": "string",
            "manufacturer": "string",
            "memory_in_gb": 0,
            "memory_type": "string",
            "permalink": "string",
            "data_centers": [
              {
                "id": "string",
                "name": "string",
                "permalink": "string",
                "country": {
                  "id": "string",
                  "name": "string",
                  "iso_code2": "string",
                  "iso_code3": "string",
                  "time_zone": "string",
                  "eu": true
                }
              }
            ]
          },
          "gpus": [
            {
              "id": "string",
              "status": "attached",
              "pending_action": "attach",
              "available": true,
              "type": {
                "id": "string",
                "name": "string",
                "manufacturer": "string",
                "memory_in_gb": 0,
                "memory_type": "string",
                "permalink": "string",
                "data_centers": [
                  {
                    "id": "string",
                    "name": "string",
                    "permalink": "string",
                    "country": {
                      "id": "string",
                      "name": "string",
                      "iso_code2": "string",
                      "iso_code3": "string",
                      "time_zone": "string",
                      "eu": true
                    }
                  }
                ]
              }
            }
          ],
          "tags": [
            {
              "id": "string",
              "name": "string",
              "color": "red",
              "created_at": 0
            }
          ],
          "tag_names": [
            "string"
          ],
          "ip_addresses": [
            {
              "id": "string",
              "address": "string",
              "reverse_dns": "string",
              "vip": true,
              "label": "string",
              "address_with_mask": "string",
              "network": {
                "id": "string",
                "name": "string",
                "permalink": "string",
                "data_center": {
                  "id": "string",
                  "name": "string",
                  "permalink": "string",
                  "country": {
                    "id": "string",
                    "name": "string",
                    "iso_code2": "string",
                    "iso_code3": "string",
                    "time_zone": "string",
                    "eu": true
                  }
                }
              },
              "allocation_id": "string",
              "allocation_type": "string"
            }
          ],
          "hypervisor": {
            "id": "string",
            "name": "string",
            "ip_address": "string"
          }
        }
      }
    ],
    "resource_ids": [
      "string"
    ],
    "ip_address": {
      "id": "string",
      "address": "string"
    },
    "https_redirect": true,
    "backend_certificate": "string",
    "backend_certificate_key": "string",
    "data_center": {
      "id": "string",
      "name": "string",
      "permalink": "string"
    },
    "enable_weighting": true,
    "weights": [
      {
        "virtual_machine_id": "string",
        "weight": 0
      }
    ],
    "standby_vms": [
      "string"
    ]
  },
  "annotations": [
    {
      "key": "string",
      "value": "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[]

OrganizationSuspendedSchema

An organization was found from the arguments provided but it was suspended

code OrganizationSuspendedEnum (string)

Possible values: [organization_suspended]

description string

detail object

OrganizationNotActivatedSchema

An organization was found from the arguments provided but it wasn't activated yet

code OrganizationNotActivatedEnum (string)

Possible values: [organization_not_activated]

description string

detail object

PermissionDeniedSchema

The authenticated identity is not permitted to perform this action

code PermissionDeniedEnum (string)

Possible values: [permission_denied]

description string

detail

object

details stringnullable

Additional information regarding the reason why permission was denied

ResourceCreationRestrictedSchema

The organization chosen is not permitted to create resources

code ResourceCreationRestrictedEnum (string)

Possible values: [resource_creation_restricted]

description string

detail

ResourceCreationRestricted

errors string[]

Example (from schema)

{}

404

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

application/json

Schema

Schema

code OrganizationNotFoundEnum (string)

Possible values: [organization_not_found]

description string
detail object

Example (from schema)

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

422

A validation error occurred with the object that was being created/updated/deleted

application/json

Schema

Schema

code ValidationErrorEnum (string)

Possible values: [validation_error]

description string

detail

ValidationError

errors string[]

Example (from schema)

{
  "code": "validation_error",
  "description": "string",
  "detail": {
    "errors": [
      "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...