API docs by Redocly

Load Balancer Management API (0.0.2)

Download OpenAPI specification:Download

Equinix Metal Load Balancers (Beta) documentation

Origins

Delete a load balancer origin

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerOriginID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string

Responses

Update a load balancer origin

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerOriginID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string
Request Body schema: application/json
name
string

A name for the origin

target
string <ipv4>

IP address of the origin

port_number
integer [ 1 .. 65535 ]

Listening port of the origin

weight
integer [ 1 .. 256 ]

Weight of the origin

active
boolean

If the origin is active

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "target": "192.168.0.1",
  • "port_number": 1,
  • "weight": 1,
  • "active": true
}

Response samples

Content type
application/json
{
  • "version": "string",
  • "message": "string",
  • "id": "string",
  • "status": 0
}

Gets a load balancer origin by ID

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerPoolID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "target": "192.168.0.1",
  • "port_number": 10,
  • "weight": 1,
  • "active": true,
  • "pool_id": "string"
}

Create a load balancer origin for a pool

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerPoolID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string
Request Body schema: application/json
name
required
string

A name for the origin

target
required
string <ipv4>

IP address of the origin

port_number
required
integer [ 1 .. 65535 ]

Listening port of the origin

weight
required
integer [ 1 .. 256 ]

Weight of the origin

active
required
boolean

If the origin is activated

pool_id
required
string

ID of the pool the origin belongs to

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "target": "192.168.0.1",
  • "port_number": 1,
  • "weight": 1,
  • "active": true,
  • "pool_id": "string"
}

Response samples

Content type
application/json
{
  • "version": "string",
  • "message": "string",
  • "id": "string",
  • "status": 0
}

Pools

Delete a loadbalancer pool

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerPoolID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string

Responses

Gets a load balancer pool by ID

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerPoolID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string

Responses

Update a load balancer pool

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerPoolID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string
Request Body schema: application/json
name
string

Name of the load balancer pool

protocol
string
Enum: "tcp" "udp"

Protocol to use for pool

add_port_ids
Array of strings

Add ports to load balancer pool

remove_port_ids
Array of strings

Removed ports from load balancer pool

clear_ports
boolean

Clear all ports from load balancer pool

add_origin_ids
Array of strings

Add origins to load balancer pool

remove_origin_ids
Array of strings

Removed origins from load balancer pool

clear_origins
boolean

Clear all origins from load balancer pool

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "protocol": "tcp",
  • "add_port_ids": [
    ],
  • "remove_port_ids": [
    ],
  • "clear_ports": true,
  • "add_origin_ids": [
    ],
  • "remove_origin_ids": [
    ],
  • "clear_origins": true
}

Response samples

Content type
application/json
{
  • "version": "string",
  • "message": "string",
  • "id": "string",
  • "status": 0
}

Ports

Delete a load balancer port

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerPortID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string

Responses

Update a load balancer port

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerPortID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string
Request Body schema: application/json
name
string

A name for the port

number
integer [ 10 .. 65535 ]

Listing port

add_pool_ids
Array of strings

Add the provided pool ids to the port

remove_pool_ids
Array of strings

Remove the provided pool ids to the port

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "number": 10,
  • "add_pool_ids": [
    ],
  • "remove_pool_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "version": "string",
  • "message": "string",
  • "id": "string",
  • "status": 0
}

Get the load balancer's ports

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string

Responses

Response samples

Content type
application/json
{
  • "ports": [
    ]
}

Create a load balancer port

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string
Request Body schema: application/json
name
required
string

A name for the port

number
required
integer [ 10 .. 65535 ]

Listing port

pool_ids
Array of strings

A list of pool IDs assigned to the port

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "number": 10,
  • "pool_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "version": "string",
  • "message": "string",
  • "id": "string",
  • "status": 0
}

Get a load balancer port by ID

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerID
required
string
portNumber
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "number": 10,
  • "loadbalancer_id": "string",
  • "pool_ids": [
    ]
}

LoadBalancers

Delete a load balancer.

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string

Responses

Get a load balancer by ID

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "provider": {
    },
  • "ports": [
    ],
  • "pools": [
    ],
  • "ips": [
    ],
  • "location": {
    }
}

Update a load balancer.

Authorizations:
KrakenD-JWT
path Parameters
loadBalancerID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string
Request Body schema: application/json
name
string

Name of the load balancer

add_port_ids
Array of strings

Add ports to load balancer

remove_port_ids
Array of strings

Removed ports from load balancer

clear_ports
boolean

Clear all ports from load balancer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "add_port_ids": [
    ],
  • "remove_port_ids": [
    ],
  • "clear_ports": true
}

Response samples

Content type
application/json
{
  • "version": "string",
  • "message": "string",
  • "id": "string",
  • "status": 0
}

Projects

Get the load balancers for a project

Authorizations:
KrakenD-JWT
path Parameters
projectID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string

Responses

Response samples

Content type
application/json
{
  • "loadbalancers": [
    ]
}

Create a load balancer for a project

Authorizations:
KrakenD-JWT
path Parameters
projectID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string
Request Body schema: application/json
name
required
string

Name of load balancer

location_id
required
string

ID of location load balancer to be deployed in

port_ids
required
Array of strings

Port IDs to associate with load balancer

provider_id
required
string

ID of load balancer provider

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "location_id": "string",
  • "port_ids": [
    ],
  • "provider_id": "string"
}

Response samples

Content type
application/json
{
  • "version": "string",
  • "message": "string",
  • "id": "string",
  • "status": 0
}

Get the pools for a project

Authorizations:
KrakenD-JWT
path Parameters
projectID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string

Responses

Response samples

Content type
application/json
{
  • "pools": [
    ]
}

Create a load balancer pool for a project

Authorizations:
KrakenD-JWT
path Parameters
projectID
required
string
header Parameters
Host
string
Traceparent
string
Tracestate
string
Request Body schema: application/json
name
required
string

Name of the load balancer pool

protocol
required
string
Enum: "tcp" "udp"

Protocol to use for pool

port_ids
Array of strings

Port ids to associate with pool

origin_ids
Array of strings

Origin ids to associate with pool

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "protocol": "tcp",
  • "port_ids": [
    ],
  • "origin_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "version": "string",
  • "message": "string",
  • "id": "string",
  • "status": 0
}