Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add a little more details and external links about the service #3

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
> [!WARNING]
> This software is currently in a beta release. For this reason, we don't recommend this for immediate usage while running production workloads. Any feedback is greatly appreciated!
> This software is currently in a beta release. For this reason, we don't recommend this for immediate usage while running production workloads. [Any feedback is greatly appreciated!](https://feedback.equinixmetal.com/network/p/load-balancer-as-a-service-lbaas)

# Equinix Load Balancers API Quickstart

[![Stability: Beta](https://img.shields.io/badge/stability-beta-33bbff.svg)]()

This document describes how to interact with an upcoming managed L3 / L4 Load Balancer-as-a-Service service, currently in beta. This service aims to be an ideal solution for directing traffic to your highly available backend Equinix Metal Servers and IPs.
Copy link
Member Author

@displague displague Nov 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

influenced by the text in the beta portal integration:

Our newest product is a managed L3 / L4 Load Balancer-as-a-Service, and is perfect for proxying traffic to your backend Metal Servers and IPs.


This document will describe how you can get started with Equinix Load Balancers via the API.

## Authentication
Expand Down Expand Up @@ -504,4 +506,4 @@ curl -H 'Content-Type: application/json' -H "Authorization: bearer <access_token
| origins.port_number | Port number of associated origin target |
| origins.active | Boolean indicated whether target is active |
| origins.created_at | Timestamp of origin creation |
| origins.updated_at | Timestamp of origin update |
| origins.updated_at | Timestamp of origin update |