STACKIT

STACKIT Network Load Balancer API

This API offers an interface to provision and manage load balancing servers in your STACKIT project. It also has the possibility of pooling target servers for…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This API offers an interface to provision and manage load balancing servers in your STACKIT project. It also has the possibility of pooling target servers for load balancing purposes.

For each load balancer provided, two VMs are deployed in your OpenStack project subject to a fee.

Endpoints 13

  • GETList all credentials in a project./v2/projects/:projectId/regions/:region/credentialsList Credentials
  • POSTCreate credentials for observability of the Load Balancer/v2/projects/:projectId/regions/:region/credentialsCreated credentials can be stored and used for the load balancer observability. For example, when using STACKIT Observability, credentials first must be…
  • GETGet a single credential reference in a project./v2/projects/:projectId/regions/:region/credentials/:credentialsRefGet Credentials
  • PUTUpdate credentials for observability in a project./v2/projects/:projectId/regions/:region/credentials/:credentialsRefUpdate Credentials
  • DELETEDelete a single credential in a project./v2/projects/:projectId/regions/:region/credentials/:credentialsRefDelete Credential
  • GETList load balancers in a project./v2/projects/:projectId/regions/:region/load-balancersListLoadBalancer will list load balancers of a project. This contains information set during creation or updates for every load balancer in the project.…
  • POSTCreate a load balancer in a project/v2/projects/:projectId/regions/:region/load-balancersCreate Load Balancer will create a load balancer. The default load balancing algorithm is round robin unless useSourceIpAddress in session persistence is…
  • GETGet a single load balancer in a project./v2/projects/:projectId/regions/:region/load-balancers/:nameGet Load Balancer will get a single load balancer of a project. This contains all the information set during creation or updates. Additionally, it will have…
  • PUTUpdate a load balancer in a project./v2/projects/:projectId/regions/:region/load-balancers/:nameUpdate Load Balancer allows the change of listeners and target pools of an existing Load Balancer. The Load balancer resource version needs to be the current…
  • DELETEDelete a given load balancer in a project./v2/projects/:projectId/regions/:region/load-balancers/:nameDeleteLoadBalancer will delete a given load balancer.
  • PUTUpdate a single target pool of a load balancer in a project./v2/projects/:projectId/regions/:region/load-balancers/:name/target-pools/:targetPoolNameReplaceTargetPool will replace a specific target pool of a load balancer with new content. Useful to add/remove target servers. will update a load balancer.…
  • GETGet the quota of Network Load Balancers in a project./v2/projects/:projectId/regions/:region/quotaRetrieves the configured Network Load Balancer quota for the project. Limit can be changed via service request.
  • GETList available service plans./v2/regions/:region/plansListPlans returns for the configured service plans for a project.

API details

Base URL
https://load-balancer.api.stackit.cloud
Authentication
None declared in the description
Operations
13 operations on 7 pathsGET 6PUT 3POST 2DELETE 2
Response formats
application/json text/plain
Description format
OpenAPI 3.0.3, API version 2.0.0

How to test the STACKIT Network Load Balancer API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the STACKIT Network Load Balancer API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List all credentials in a project.” (GET /v2/projects/:projectId/regions/:region/credentials), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the STACKIT Network Load Balancer API?

This API offers an interface to provision and manage load balancing servers in your STACKIT project. It also has the possibility of pooling target servers for… It is listed under Developer tools and has 13 endpoints.

Who publishes the STACKIT Network Load Balancer API?

It is listed from STACKIT's public API description (an OpenAPI document), not published by STACKIT on Swastik Codes. Anyone who controls stackit.cloud can claim the profile by adding a DNS TXT record.

What is the base URL of the STACKIT Network Load Balancer API?

Requests go to https://load-balancer.api.stackit.cloud. Endpoint paths are added to this base URL.

How do I authenticate with the STACKIT Network Load Balancer API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the STACKIT Network Load Balancer API have?

13 operations on 7 paths (6 GET, 3 PUT, 2 POST, 2 DELETE).

Is forking the STACKIT Network Load Balancer API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.