{ "components": { "schemas": { "ActiveHealthCheck": { "properties": { "altPort": { "description": "Overrides the default port used for health check probes.", "example": 8090, "format": "int32", "title": "Health Check Port", "type": "integer" }, "healthyThreshold": { "description": "Healthy threshold of the health checking", "format": "int32", "maximum": 1000000, "minimum": 1, "title": "Healthy threshold", "type": "integer" }, "httpHealthChecks": { "$ref": "#/components/schemas/HttpHealthChecks" }, "interval": { "description": "Interval duration of health checking in seconds", "example": "3s", "pattern": "^-?(?:0|[1-9][0-9]{0,11})(?:\\.[0-9]{1,9})?s$", "title": "Interval", "type": "string" }, "intervalJitter": { "description": "Interval duration threshold of the health checking in seconds", "example": "3s", "pattern": "^-?(?:0|[1-9][0-9]{0,11})(?:\\.[0-9]{1,9})?s$", "title": "Interval threshold", "type": "string" }, "timeout": { "description": "Active health checking timeout duration in seconds", "example": "3s", "pattern": "^-?(?:0|[1-9][0-9]{0,11})(?:\\.[0-9]{1,9})?s$", "title": "Timeout", "type": "string" }, "unhealthyThreshold": { "description": "Unhealthy threshold of the health checking", "format": "int32", "maximum": 1000000, "minimum": 1, "title": "Unhealthy threshold", "type": "integer" } }, "type": "object" }, "CreateCredentialsPayload": { "properties": { "displayName": { "description": "Credential name", "example": "my-metrics-credential", "pattern": "^[0-9a-z](?:(?:[0-9a-z]|-){0,251}[0-9a-z])?$", "type": "string" }, "password": { "description": "A valid password used for an existing STACKIT Observability instance, which is used during basic auth.", "title": "Password", "type": "string" }, "username": { "description": "A valid username used for an existing STACKIT Observability instance, which is used during basic auth.", "title": "Username", "type": "string" } }, "type": "object" }, "CreateCredentialsResponse": { "properties": { "credential": { "$ref": "#/components/schemas/CredentialsResponse" } }, "type": "object" }, "CreateLoadBalancerPayload": { "properties": { "disableTargetSecurityGroupAssignment": { "description": "Disable target security group assignemt to allow targets outside of the given network. Connectivity to targets need to be ensured by the customer, including routing and Security Groups (targetSecurityGroup can be assigned). Not changeable after creation.", "type": "boolean" }, "errors": { "description": "Reports all errors a load balancer has.", "items": { "$ref": "#/components/schemas/LoadBalancerError" }, "readOnly": true, "type": "array" }, "externalAddress": { "description": "External load balancer IP address where this load balancer is exposed. Not changeable after creation.", "example": "192.0.2.5", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels represent user-defined metadata as key-value pairs.\nLabel count should not exceed 64 per LB.\n**Key Formatting Rules:**\nLength: 1-63 characters.\nCharacters: Must begin and end with [a-zA-Z0-9]. May contain dashes (-), underscores (_), dots (.), and alphanumerics in between.\nKeys starting with 'stackit-' are system-reserved; users MUST NOT manage them.\n\n**Value Formatting Rules:**\nLength: 0-63 characters (empty string explicitly allowed).\nCharacters (for non-empty values): Must begin and end with [a-zA-Z0-9]. May contain dashes (-), underscores (_), dots (.), and alphanumerics in between.\n", "example": { "cost.center": "billing.dept", "environment": "prod", "name": "my-app", "region": "" }, "type": "object" }, "listeners": { "description": "There is a maximum listener count of 20.\n\nPort and protocol limitations:\n\n- UDP listeners cannot have the same port.\n- TCP-derived listeners cannot have the same port. A TCP-derived listener is any listener that listens on a TCP port. As of now those are: TCP, TCP_PROXY, and PROTOCOL_TLS_PASSTHROUGH. The only exception is, if all listeners for the same port are PROTOCOL_TLS_PASSTHROUGH.\n- PROTOCOL_TLS_PASSTHROUGH listeners cannot have the same port and at least one common domain name.\n- PROTOCOL_TLS_PASSTHROUGH listeners can have the same domain name and different ports though (e.g. ports 443 and 8443 for domain example.com).\n- PROTOCOL_TLS_PASSTHROUGH listeners without a domain name serve as a default listener and you can have only one default listener.\n", "items": { "$ref": "#/components/schemas/Listener" }, "title": "List of all listeners which will accept traffic.", "type": "array" }, "loadBalancerSecurityGroup": { "allOf": [ { "$ref": "#/components/schemas/SecurityGroup" } ], "description": "Security Group permitting network traffic from the LoadBalancer to the targets. Useful when disableTargetSecurityGroupAssignment=true to manually assign target security groups to targets.", "readOnly": true }, "name": { "description": "Load balancer name. Not changeable after creation.", "example": "my-load-balancer", "pattern": "^[0-9a-z](?:(?:[0-9a-z]|-){0,61}[0-9a-z])?$", "type": "string" }, "networks": { "description": "List of networks that listeners and targets reside in. Currently limited to one. Not changeable after creation.", "items": { "$ref": "#/components/schemas/Network" }, "type": "array" }, "options": { "$ref": "#/components/schemas/LoadBalancerOptions" }, "planId": { "description": "Service Plan configures the size of the Load Balancer. Currently supported plans are p10, p50, p250 and p750. This list can change in the future where plan ids will be removed and new plans by added. That is the reason this is not an enum.", "type": "string" }, "privateAddress": { "description": "Transient private load balancer IP address that can change any time.", "example": "10.0.0.1", "readOnly": true, "type": "string" }, "region": { "description": "Region of the LoadBalancer", "example": "eu01", "readOnly": true, "type": "string" }, "status": { "enum": [ "STATUS_UNSPECIFIED", "STATUS_PENDING", "STATUS_READY", "STATUS_ERROR", "STATUS_TERMINATING" ], "readOnly": true, "type": "string" }, "targetPools": { "description": "List of all target pools which will be used in the load balancer. Limited to 20.", "items": { "$ref": "#/components/schemas/TargetPool" }, "type": "array" }, "targetSecurityGroup": { "allOf": [ { "$ref": "#/components/schemas/SecurityGroup" } ], "description": "Security Group that allows the targets to receive traffic from the LoadBalancer. Useful when disableTargetSecurityGroupAssignment=true to manually assign target security groups to targets.", "readOnly": true }, "version": { "description": "Load balancer resource version.\nMust be empty or unset for creating load balancers, non-empty for updating load balancers. Semantics:\nWhile retrieving load balancers, this is the current version of this load balancer resource that changes during updates of the load balancers. On updates this field specified the load balancer version you calculated your update for instead of the future version to enable concurrency safe updates. Update calls will then report the new version in their result as you would see with a load balancer retrieval call later. There exist no total order of the version, so you can only compare it for equality, but not for less/greater than another version. Since the creation of load balancer is always intended to create the first version of it, there should be no existing version. That's why this field must by empty of not present in that case.", "example": "lb-238165323", "type": "string" } }, "type": "object" }, "CredentialsResponse": { "properties": { "credentialsRef": { "description": "The credentials reference can be used for observability of the Load Balancer.", "title": "Credentials reference", "type": "string" }, "displayName": { "description": "Credential name", "example": "my-metrics-credential", "pattern": "^[0-9a-z](?:(?:[0-9a-z]|-){0,61}[0-9a-z])?$", "type": "string" }, "region": { "description": "Region of the Credential", "example": "eu01", "type": "string" }, "username": { "description": "The username used for the STACKIT Observability instance", "title": "Username", "type": "string" } }, "type": "object" }, "DeleteCredentialsResponse": { "type": "object" }, "DeleteLoadBalancerResponse": { "description": "Response for deleting a load balancer has an empty body if successful.", "type": "object" }, "GetCredentialsResponse": { "properties": { "credential": { "$ref": "#/components/schemas/CredentialsResponse" } }, "type": "object" }, "GetQuotaResponse": { "properties": { "maxCredentials": { "description": "The maximum number of observability credentials that can be stored in this project.", "format": "int32", "maximum": 1000000, "minimum": -1, "title": "Observability credentials max quota", "type": "integer" }, "maxLoadBalancers": { "description": "The maximum number of load balancing servers in this project.", "format": "int32", "maximum": 1000000, "minimum": -1, "title": "Load Balancer max quota", "type": "integer" }, "projectId": { "description": "Project identifier", "example": "2438ac3c-37eb-4902-adef-ed16b4431030", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "readOnly": true, "type": "string" }, "region": { "description": "Region", "example": "eu01", "format": "string", "pattern": "^[a-z]{2,4}[0-9]{2}$", "readOnly": true, "type": "string" }, "usedCredentials": { "description": "The number of observability credentials that are currently existing in this project.", "format": "int32", "maximum": 1000000, "minimum": -1, "title": "Observability credentials used quota", "type": "integer" }, "usedLoadBalancers": { "description": "The number of load balancing servers that are currently existing in this project.", "format": "int32", "maximum": 1000000, "minimum": -1, "title": "Load Balancer used quota", "type": "integer" } }, "type": "object" }, "GoogleProtobufAny": { "additionalProperties": true, "description": "Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.", "properties": { "@type": { "description": "The type of the serialized message.", "type": "string" } }, "type": "object" }, "HttpHealthChecks": { "description": "Options for the HTTP health checking.", "properties": { "okStatuses": { "description": "List of HTTP status codes that indicate a healthy response", "items": { "type": "string" }, "maximum": 299, "minimum": 200, "title": "HTTP Health Checks' status code", "type": "array" }, "path": { "description": "Path to send the health check request to", "maxLength": 253, "minLength": 1, "pattern": "^(?:\\/[a-zA-Z0-9\\-._]+)*\\/?$", "type": "string" }, "tls": { "$ref": "#/components/schemas/TlsConfig" } }, "type": "object" }, "ListCredentialsResponse": { "properties": { "credentials": { "items": { "$ref": "#/components/schemas/CredentialsResponse" }, "type": "array" } }, "type": "object" }, "ListLoadBalancersResponse": { "properties": { "loadBalancers": { "items": { "$ref": "#/components/schemas/LoadBalancer" }, "type": "array" }, "nextPageId": { "description": "Continue token from the ListLoadBalancerResponse with Limit option", "example": "eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6NTQ1Njk3ODA2LCJzdGFydCI6Im15LWFsYi1uZXdcdTAwMDAifQ", "format": "string", "pattern": "^[0-9a-z](?:(?:[0-9a-z]|-){0,61}[0-9a-z])?$", "type": "string" } }, "type": "object" }, "ListPlansResponse": { "properties": { "validPlans": { "items": { "$ref": "#/components/schemas/PlanDetails" }, "type": "array" } }, "type": "object" }, "Listener": { "properties": { "displayName": { "type": "string" }, "name": { "description": "Will be used to reference a listener and will replace display name in the future. Currently uses \u003cprotocol\u003e-\u003cport\u003e as the name if no display name is given.", "example": "my-listener", "readOnly": true, "type": "string" }, "port": { "description": "Port number where we listen for traffic", "format": "int32", "maximum": 65535, "minimum": 1, "type": "integer" }, "protocol": { "description": "Protocol is the highest network protocol we understand to load balance. Currently only PROTOCOL_TCP, PROTOCOL_TCP_PROXY and PROTOCOL_TLS_PASSTHROUGH are supported.", "enum": [ "PROTOCOL_UNSPECIFIED", "PROTOCOL_TCP", "PROTOCOL_UDP", "PROTOCOL_TCP_PROXY", "PROTOCOL_TLS_PASSTHROUGH" ], "type": "string" }, "serverNameIndicators": { "deprecated": true, "description": "Server Name Indicators config for domains to be routed to the desired target pool for this listener.", "items": { "$ref": "#/components/schemas/ServerNameIndicator" }, "type": "array" }, "targetPool": { "description": "Reference target pool by target pool name.", "example": "my-target-pool", "type": "string" }, "tcp": { "$ref": "#/components/schemas/OptionsTCP" }, "udp": { "$ref": "#/components/schemas/OptionsUDP" } }, "type": "object" }, "LoadBalancer": { "properties": { "disableTargetSecurityGroupAssignment": { "description": "Disable target security group assignemt to allow targets outside of the given network. Connectivity to targets need to be ensured by the customer, including routing and Security Groups (targetSecurityGroup can be assigned). Not changeable after creation.", "type": "boolean" }, "errors": { "description": "Reports all errors a load balancer has.", "items": { "$ref": "#/components/schemas/LoadBalancerError" }, "readOnly": true, "type": "array" }, "externalAddress": { "description": "External load balancer IP address where this load balancer is exposed. Not changeable after creation.", "example": "192.0.2.5", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels represent user-defined metadata as key-value pairs.\nLabel count should not exceed 64 per LB.\n**Key Formatting Rules:**\nLength: 1-63 characters.\nCharacters: Must begin and end with [a-zA-Z0-9]. May contain dashes (-), underscores (_), dots (.), and alphanumerics in between.\nKeys starting with 'stackit-' are system-reserved; users MUST NOT manage them.\n\n**Value Formatting Rules:**\nLength: 0-63 characters (empty string explicitly allowed).\nCharacters (for non-empty values): Must begin and end with [a-zA-Z0-9]. May contain dashes (-), underscores (_), dots (.), and alphanumerics in between.\n", "example": { "cost.center": "billing.dept", "environment": "prod", "name": "my-app", "region": "" }, "type": "object" }, "listeners": { "description": "There is a maximum listener count of 20.\n\nPort and protocol limitations:\n\n- UDP listeners cannot have the same port.\n- TCP-derived listeners cannot have the same port. A TCP-derived listener is any listener that listens on a TCP port. As of now those are: TCP, TCP_PROXY, and PROTOCOL_TLS_PASSTHROUGH. The only exception is, if all listeners for the same port are PROTOCOL_TLS_PASSTHROUGH.\n- PROTOCOL_TLS_PASSTHROUGH listeners cannot have the same port and at least one common domain name.\n- PROTOCOL_TLS_PASSTHROUGH listeners can have the same domain name and different ports though (e.g. ports 443 and 8443 for domain example.com).\n- PROTOCOL_TLS_PASSTHROUGH listeners without a domain name serve as a default listener and you can have only one default listener.\n", "items": { "$ref": "#/components/schemas/Listener" }, "title": "List of all listeners which will accept traffic.", "type": "array" }, "loadBalancerSecurityGroup": { "allOf": [ { "$ref": "#/components/schemas/SecurityGroup" } ], "description": "Security Group permitting network traffic from the LoadBalancer to the targets. Useful when disableTargetSecurityGroupAssignment=true to manually assign target security groups to targets.", "readOnly": true }, "name": { "description": "Load balancer name. Not changeable after creation.", "example": "my-load-balancer", "pattern": "^[0-9a-z](?:(?:[0-9a-z]|-){0,61}[0-9a-z])?$", "type": "string" }, "networks": { "description": "List of networks that listeners and targets reside in. Currently limited to one. Not changeable after creation.", "items": { "$ref": "#/components/schemas/Network" }, "type": "array" }, "options": { "$ref": "#/components/schemas/LoadBalancerOptions" }, "planId": { "description": "Service Plan configures the size of the Load Balancer. Currently supported plans are p10, p50, p250 and p750. This list can change in the future where plan ids will be removed and new plans by added. That is the reason this is not an enum.", "type": "string" }, "privateAddress": { "description": "Transient private load balancer IP address that can change any time.", "example": "10.0.0.1", "readOnly": true, "type": "string" }, "region": { "description": "Region of the LoadBalancer", "example": "eu01", "readOnly": true, "type": "string" }, "status": { "enum": [ "STATUS_UNSPECIFIED", "STATUS_PENDING", "STATUS_READY", "STATUS_ERROR", "STATUS_TERMINATING" ], "readOnly": true, "type": "string" }, "targetPools": { "description": "List of all target pools which will be used in the load balancer. Limited to 20.", "items": { "$ref": "#/components/schemas/TargetPool" }, "type": "array" }, "targetSecurityGroup": { "allOf": [ { "$ref": "#/components/schemas/SecurityGroup" } ], "description": "Security Group that allows the targets to receive traffic from the LoadBalancer. Useful when disableTargetSecurityGroupAssignment=true to manually assign target security groups to targets.", "readOnly": true }, "version": { "description": "Load balancer resource version.\nMust be empty or unset for creating load balancers, non-empty for updating load balancers. Semantics:\nWhile retrieving load balancers, this is the current version of this load balancer resource that changes during updates of the load balancers. On updates this field specified the load balancer version you calculated your update for instead of the future version to enable concurrency safe updates. Update calls will then report the new version in their result as you would see with a load balancer retrieval call later. There exist no total order of the version, so you can only compare it for equality, but not for less/greater than another version. Since the creation of load balancer is always intended to create the first version of it, there should be no existing version. That's why this field must by empty of not present in that case.", "example": "lb-238165323", "type": "string" } }, "type": "object" }, "LoadBalancerError": { "properties": { "description": { "description": "The error description contains additional helpful user information to fix the error state of the load balancer. For example the IP 45.135.247.139 does not exist in the project, then the description will report: Floating IP \"45.135.247.139\" could not be found or if the IP was deleted then you will get a proper error message.", "type": "string" }, "type": { "description": "The error type specifies which part of the load balancer encountered the error. I.e. the API will not check if a provided public IP is actually available in the project. Instead the load balancer with try to use the provided IP and if not available reports TYPE_FIP_NOT_CONFIGURED error or TYPE_FIP_NOT_FOUND if the IP was deleted.", "enum": [ "TYPE_UNSPECIFIED", "TYPE_INTERNAL", "TYPE_QUOTA_SECGROUP_EXCEEDED", "TYPE_QUOTA_SECGROUPRULE_EXCEEDED", "TYPE_PORT_NOT_CONFIGURED", "TYPE_FIP_NOT_CONFIGURED", "TYPE_TARGET_NOT_ACTIVE", "TYPE_METRICS_MISCONFIGURED", "TYPE_LOGS_MISCONFIGURED", "TYPE_FIP_NOT_FOUND", "TYPE_IP_EXHAUSTED", "TYPE_DNS_NOT_CONFIGURED", "TYPE_VM_PORT_NOT_CONFIGURED" ], "type": "string" } }, "type": "object" }, "LoadBalancerOptions": { "description": "Defines any optional functionality you want to have enabled on your load balancer.", "properties": { "accessControl": { "$ref": "#/components/schemas/LoadbalancerOptionAccessControl" }, "accessLogs": { "description": "Enable per-request access logs on the Load Balancer. Defaults to false. Enable only when the Load Balancer's expected traffic volume can be sustained by the downstream logging pipeline, as access-log volume scales linearly with request rate. Requires a STACKIT Telemetry Router to be set up for the logs to be viewable.", "title": "Access logs", "type": "boolean" }, "ephemeralAddress": { "type": "boolean" }, "observability": { "$ref": "#/components/schemas/LoadbalancerOptionObservability" }, "privateNetworkOnly": { "description": "Load Balancer is accessible only via a private network ip address. Not changeable after creation.", "title": "Private Network Only", "type": "boolean" } }, "type": "object" }, "LoadbalancerOptionAccessControl": { "description": "Use this option to limit the IP ranges that can use the load balancer.", "properties": { "allowedSourceRanges": { "description": "Load Balancer is accessible only from an IP address in this range", "items": { "type": "string" }, "title": "Load Balancer source ranges", "type": "array" } }, "type": "object" }, "LoadbalancerOptionLogs": { "properties": { "credentialsRef": { "description": "Credentials reference for logging. This reference is created via the observability create endpoint and the credential needs to contain the basic auth username and password for the logging solution the push URL points to. Then this enables monitoring via remote write for the Load Balancer.", "title": "Credentials reference", "type": "string" }, "pushUrl": { "description": "The Observability(Logs)/Loki remote write Push URL you want the logs to be shipped to.", "example": "https://logs.stackit\u003cid\u003e.argus.eu01.stackit.cloud/instances/\u003cinstance-id\u003e/loki/api/v1/push", "title": "Push URL", "type": "string" } }, "type": "object" }, "LoadbalancerOptionMetrics": { "properties": { "credentialsRef": { "description": "Credentials reference for metrics. This reference is created via the observability create endpoint and the credential needs to contain the basic auth username and password for the metrics solution the push URL points to. Then this enables monitoring via remote write for the Load Balancer.", "title": "Credentials reference", "type": "string" }, "pushUrl": { "description": "The Observability(Metrics)/Prometheus remote write push URL you want the metrics to be shipped to.", "example": "https://push.metrics.stackit\u003cid\u003e.argus.eu01.stackit.cloud/instances/\u003cinstance-id\u003e/api/v1/receive", "title": "Push URL", "type": "string" } }, "type": "object" }, "LoadbalancerOptionObservability": { "description": "We offer Load Balancer observability via STACKIT Observability or external solutions.", "properties": { "logs": { "$ref": "#/components/schemas/LoadbalancerOptionLogs" }, "metrics": { "$ref": "#/components/schemas/LoadbalancerOptionMetrics" } }, "type": "object" }, "Network": { "properties": { "networkId": { "description": "Openstack network ID", "example": "2028e5d4-af4f-45e2-98df-502be37a4317", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "type": "string" }, "role": { "description": "The role defines how the load balancer is using the network. Currently only ROLE_LISTENERS_AND_TARGETS is supported.", "enum": [ "ROLE_UNSPECIFIED", "ROLE_LISTENERS_AND_TARGETS", "ROLE_LISTENERS", "ROLE_TARGETS" ], "type": "string" } }, "type": "object" }, "OptionsTCP": { "description": "ProtocolOptionsTCP options to be configured for the PROTOCOL_TCP, PROTOCOL_TCP_PROXY, and PROTOCOL_TLS_PASSTHROUGH protocols. TCP options for the SNI listeners with the same port must be the same.", "properties": { "idleTimeout": { "description": "The connection idle timeout to be used with the protocol. The default value is set to 5 minutes, and the maximum value is one hour.", "example": "300s", "pattern": "^-?(?:0|[1-9][0-9]{0,11})(?:\\.[0-9]{1,9})?s$", "title": "Idle timeout", "type": "string" } }, "type": "object" }, "OptionsUDP": { "description": "ProtocolOptionsUDP options to be configured for the PROTOCOL_UDP protocol.", "properties": { "idleTimeout": { "description": "The connection idle timeout to be used with the protocol. The default value is set to 1 minute, and the maximum value is 2 minutes.", "example": "60s", "pattern": "^-?(?:0|[1-9][0-9]{0,11})(?:\\.[0-9]{1,9})?s$", "title": "Idle timeout", "type": "string" } }, "type": "object" }, "PlanDetails": { "properties": { "description": { "description": "Description", "example": "Description for p10", "type": "string" }, "flavorName": { "description": "Flavor Name", "example": "t1.2", "type": "string" }, "maxConnections": { "description": "Maximum number of concurrent connections per load balancer VM instance.", "format": "int32", "title": "Load Balancer max supported connections", "type": "integer" }, "name": { "description": "Service Plan Name", "example": "Essential-Network-Load-Balancer-10-EU01", "type": "string" }, "planId": { "description": "Service Plan Identifier", "example": "p10", "type": "string" }, "region": { "description": "Region this Plan is available in", "example": "eu01", "type": "string" } }, "type": "object" }, "SecurityGroup": { "properties": { "id": { "description": "ID of the security Group", "type": "string" }, "name": { "description": "Name of the security Group", "type": "string" } }, "type": "object" }, "ServerNameIndicator": { "properties": { "name": { "description": "The domain name for this SNI config.", "type": "string" } }, "type": "object" }, "SessionPersistence": { "properties": { "useSourceIpAddress": { "description": "If enabled then all connections from one source IP address are redirected to the same target. This setting changes the load balancing algorithm to Maglev.", "example": true, "title": "UseSourceIPAddress", "type": "boolean" } }, "type": "object" }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "properties": { "code": { "description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].", "format": "int32", "type": "integer" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "$ref": "#/components/schemas/GoogleProtobufAny" }, "type": "array" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.", "type": "string" } }, "type": "object" }, "Target": { "properties": { "displayName": { "description": "Target name", "example": "my-target", "pattern": "^[0-9a-zA-Z](?:(?:[0-9a-zA-Z]|-){0,61}[0-9a-zA-Z])?$", "type": "string" }, "ip": { "description": "Target IP. Must by unique within a target pool.", "example": "192.0.2.5", "type": "string" } }, "type": "object" }, "TargetPool": { "properties": { "activeHealthCheck": { "$ref": "#/components/schemas/ActiveHealthCheck" }, "name": { "description": "Target pool name", "example": "my-target-pool", "pattern": "^[0-9a-z](?:(?:[0-9a-z]|-){0,61}[0-9a-z])?$", "type": "string" }, "sessionPersistence": { "$ref": "#/components/schemas/SessionPersistence" }, "targetPort": { "description": "The number identifying the port where each target listens for traffic.", "example": 5732, "format": "int32", "maximum": 65535, "minimum": 1, "type": "integer" }, "targets": { "description": "List of all targets which will be used in the pool. Limited to 250.", "items": { "$ref": "#/components/schemas/Target" }, "type": "array" } }, "type": "object" }, "TlsConfig": { "description": "Set this to configure TLS settings.", "properties": { "customCa": { "description": "Specifies a custom Certificate Authority (CA). When provided, the target pool will trust certificates signed by this CA, in addition to any system-trusted CAs. This is useful for scenarios where the target pool needs to communicate with servers using self-signed or internally-issued certificates. Enabled needs to be set to true and skip validation to false for this option.", "format": "bytes", "title": "Custom Certificate Authority", "type": "string" }, "enabled": { "description": "Enable TLS (Transport Layer Security) bridging for the connection between Application Load Balancer and targets in this pool. When enabled, public CAs are trusted. Can be used in tandem with the options either custom CA or skip validation or alone.", "title": "Enabled", "type": "boolean" }, "skipCertificateValidation": { "description": "Bypass certificate validation for TLS bridging in this target pool. This option is insecure and can only be used with public CAs by setting enabled true. Meant to be used for testing purposes only!", "title": "Skip Certificate Validation", "type": "boolean" } }, "type": "object" }, "UpdateCredentialsPayload": { "properties": { "displayName": { "description": "Credential name", "example": "my-metrics-credential", "pattern": "^[0-9a-z](?:(?:[0-9a-z]|-){0,251}[0-9a-z])?$", "type": "string" }, "password": { "description": "A valid password used for an existing STACKIT Observability instance, which is used during basic auth.", "title": "Password", "type": "string" }, "username": { "description": "A valid username used for an existing STACKIT Observability instance, which is used during basic auth.", "title": "Username", "type": "string" } }, "type": "object" }, "UpdateCredentialsResponse": { "properties": { "credential": { "$ref": "#/components/schemas/CredentialsResponse" } }, "type": "object" }, "UpdateLoadBalancerPayload": { "properties": { "disableTargetSecurityGroupAssignment": { "description": "Disable target security group assignemt to allow targets outside of the given network. Connectivity to targets need to be ensured by the customer, including routing and Security Groups (targetSecurityGroup can be assigned). Not changeable after creation.", "type": "boolean" }, "errors": { "description": "Reports all errors a load balancer has.", "items": { "$ref": "#/components/schemas/LoadBalancerError" }, "readOnly": true, "type": "array" }, "externalAddress": { "description": "External load balancer IP address where this load balancer is exposed. Not changeable after creation.", "example": "192.0.2.5", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels represent user-defined metadata as key-value pairs.\nLabel count should not exceed 64 per LB.\n**Key Formatting Rules:**\nLength: 1-63 characters.\nCharacters: Must begin and end with [a-zA-Z0-9]. May contain dashes (-), underscores (_), dots (.), and alphanumerics in between.\nKeys starting with 'stackit-' are system-reserved; users MUST NOT manage them.\n\n**Value Formatting Rules:**\nLength: 0-63 characters (empty string explicitly allowed).\nCharacters (for non-empty values): Must begin and end with [a-zA-Z0-9]. May contain dashes (-), underscores (_), dots (.), and alphanumerics in between.\n", "example": { "cost.center": "billing.dept", "environment": "prod", "name": "my-app", "region": "" }, "type": "object" }, "listeners": { "description": "There is a maximum listener count of 20.\n\nPort and protocol limitations:\n\n- UDP listeners cannot have the same port.\n- TCP-derived listeners cannot have the same port. A TCP-derived listener is any listener that listens on a TCP port. As of now those are: TCP, TCP_PROXY, and PROTOCOL_TLS_PASSTHROUGH. The only exception is, if all listeners for the same port are PROTOCOL_TLS_PASSTHROUGH.\n- PROTOCOL_TLS_PASSTHROUGH listeners cannot have the same port and at least one common domain name.\n- PROTOCOL_TLS_PASSTHROUGH listeners can have the same domain name and different ports though (e.g. ports 443 and 8443 for domain example.com).\n- PROTOCOL_TLS_PASSTHROUGH listeners without a domain name serve as a default listener and you can have only one default listener.\n", "items": { "$ref": "#/components/schemas/Listener" }, "title": "List of all listeners which will accept traffic.", "type": "array" }, "loadBalancerSecurityGroup": { "allOf": [ { "$ref": "#/components/schemas/SecurityGroup" } ], "description": "Security Group permitting network traffic from the LoadBalancer to the targets. Useful when disableTargetSecurityGroupAssignment=true to manually assign target security groups to targets.", "readOnly": true }, "name": { "description": "Load balancer name. Not changeable after creation.", "example": "my-load-balancer", "pattern": "^[0-9a-z](?:(?:[0-9a-z]|-){0,61}[0-9a-z])?$", "type": "string" }, "networks": { "description": "List of networks that listeners and targets reside in. Currently limited to one. Not changeable after creation.", "items": { "$ref": "#/components/schemas/Network" }, "type": "array" }, "options": { "$ref": "#/components/schemas/LoadBalancerOptions" }, "planId": { "description": "Service Plan configures the size of the Load Balancer. Currently supported plans are p10, p50, p250 and p750. This list can change in the future where plan ids will be removed and new plans by added. That is the reason this is not an enum.", "type": "string" }, "privateAddress": { "description": "Transient private load balancer IP address that can change any time.", "example": "10.0.0.1", "readOnly": true, "type": "string" }, "region": { "description": "Region of the LoadBalancer", "example": "eu01", "readOnly": true, "type": "string" }, "status": { "enum": [ "STATUS_UNSPECIFIED", "STATUS_PENDING", "STATUS_READY", "STATUS_ERROR", "STATUS_TERMINATING" ], "readOnly": true, "type": "string" }, "targetPools": { "description": "List of all target pools which will be used in the load balancer. Limited to 20.", "items": { "$ref": "#/components/schemas/TargetPool" }, "type": "array" }, "targetSecurityGroup": { "allOf": [ { "$ref": "#/components/schemas/SecurityGroup" } ], "description": "Security Group that allows the targets to receive traffic from the LoadBalancer. Useful when disableTargetSecurityGroupAssignment=true to manually assign target security groups to targets.", "readOnly": true }, "version": { "description": "Load balancer resource version.\nMust be empty or unset for creating load balancers, non-empty for updating load balancers. Semantics:\nWhile retrieving load balancers, this is the current version of this load balancer resource that changes during updates of the load balancers. On updates this field specified the load balancer version you calculated your update for instead of the future version to enable concurrency safe updates. Update calls will then report the new version in their result as you would see with a load balancer retrieval call later. There exist no total order of the version, so you can only compare it for equality, but not for less/greater than another version. Since the creation of load balancer is always intended to create the first version of it, there should be no existing version. That's why this field must by empty of not present in that case.", "example": "lb-238165323", "type": "string" } }, "type": "object" }, "UpdateTargetPoolPayload": { "properties": { "activeHealthCheck": { "$ref": "#/components/schemas/ActiveHealthCheck" }, "name": { "description": "Target pool name", "example": "my-target-pool", "pattern": "^[0-9a-z](?:(?:[0-9a-z]|-){0,61}[0-9a-z])?$", "type": "string" }, "sessionPersistence": { "$ref": "#/components/schemas/SessionPersistence" }, "targetPort": { "description": "The number identifying the port where each target listens for traffic.", "example": 5732, "format": "int32", "maximum": 65535, "minimum": 1, "type": "integer" }, "targets": { "description": "List of all targets which will be used in the pool. Limited to 250.", "items": { "$ref": "#/components/schemas/Target" }, "type": "array" } }, "type": "object" } } }, "info": { "description": "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.\n\nFor each load balancer provided, two VMs are deployed in your OpenStack project subject to a fee.", "title": "STACKIT Network Load Balancer API", "version": "2.0.0" }, "openapi": "3.0.3", "paths": { "/v2/projects/{projectId}/regions/{region}/credentials": { "get": { "description": "List Credentials", "operationId": "ListCredentials", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "region", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCredentialsResponse" } } }, "description": "OK" }, "400": { "description": "One or more fields are invalid." }, "401": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Unauthorized" }, "403": { "description": "this project_id is not allowed to try this API" }, "500": { "description": "internal error - please retry again later or contact support if the issue persists" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } }, "description": "Default error response" } }, "summary": "List all credentials in a project.", "x-stackit-authorization": { "actions": [ "nlb.credentials.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.loadbalancer" ] } } }, "post": { "description": "Created credentials can be stored and used for the load balancer observability. For example, when using STACKIT\n Observability, credentials first must be created for that STACKIT Observability instance (by using their API or the\n STACKIT Portal) and then can be provided to the load balancer by storing them with this endpoint.", "operationId": "CreateCredentials", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "region", "required": true, "schema": { "type": "string" } }, { "example": "2438ac3c-37eb-4902-adef-ed16b4431030", "in": "header", "name": "X-Request-ID", "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCredentialsPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCredentialsResponse" } } }, "description": "OK" }, "400": { "description": "One or more fields are invalid." }, "401": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Unauthorized" }, "403": { "description": "this project_id is not allowed to try this API" }, "429": { "description": "maximum number of credentials reached - please contact support to increase it" }, "500": { "description": "internal error - please retry again later or contact support if the issue persists" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } }, "description": "Default error response" } }, "summary": "Create credentials for observability of the Load Balancer", "x-stackit-authorization": { "actions": [ "nlb.credentials.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.loadbalancer" ] } } } }, "/v2/projects/{projectId}/regions/{region}/credentials/{credentialsRef}": { "delete": { "description": "Delete Credential", "operationId": "DeleteCredentials", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "region", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "credentialsRef", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCredentialsResponse" } } }, "description": "OK" }, "400": { "description": "One or more fields are invalid." }, "401": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Unauthorized" }, "403": { "description": "this project_id is not allowed to try this API" }, "500": { "description": "internal error - please retry again later or contact support if the issue persists" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } }, "description": "Default error response" } }, "summary": "Delete a single credential in a project.", "x-stackit-authorization": { "actions": [ "nlb.credentials.delete" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.loadbalancer" ] } } }, "get": { "description": "Get Credentials", "operationId": "GetCredentials", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "region", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "credentialsRef", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCredentialsResponse" } } }, "description": "OK" }, "400": { "description": "One or more fields are invalid." }, "401": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Unauthorized" }, "403": { "description": "this project_id is not allowed to try this API" }, "404": { "description": "credential reference not found" }, "500": { "description": "internal error - please retry again later or contact support if the issue persists" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } }, "description": "Default error response" } }, "summary": "Get a single credential reference in a project.", "x-stackit-authorization": { "actions": [ "nlb.credentials.get" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.loadbalancer" ] } } }, "put": { "description": "Update Credentials", "operationId": "UpdateCredentials", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "region", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "credentialsRef", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCredentialsPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCredentialsResponse" } } }, "description": "OK" }, "400": { "description": "One or more fields are invalid." }, "401": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Unauthorized" }, "403": { "description": "this project_id is not allowed to try this API" }, "404": { "description": "credential reference not found" }, "500": { "description": "internal error - please retry again later or contact support if the issue persists" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } }, "description": "Default error response" } }, "summary": "Update credentials for observability in a project.", "x-stackit-authorization": { "actions": [ "nlb.credentials.update" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.loadbalancer" ] } } } }, "/v2/projects/{projectId}/regions/{region}/load-balancers": { "get": { "description": "ListLoadBalancer will list load balancers of a project. This contains information set during\n creation or updates for every load balancer in the project. Additionally, it will have information about\n the state of the load balancer in the form of a status field and error description feedback.", "operationId": "ListLoadBalancers", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "region", "required": true, "schema": { "type": "string" } }, { "description": "page_size specifies how many load balancers should be returned on this page. Must be a positive number \u003c= 1000", "in": "query", "name": "pageSize", "schema": { "type": "string" } }, { "description": "page_id is a page identifier returned by the previous response and is used to request the next page", "in": "query", "name": "pageId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLoadBalancersResponse" } } }, "description": "OK" }, "400": { "description": "One or more fields are invalid." }, "401": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Unauthorized" }, "403": { "description": "this project_id is not allowed to try this API" }, "410": { "description": "page_id is expired" }, "500": { "description": "internal error - please retry again later or contact support if the issue persists" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } }, "description": "Default error response" } }, "summary": "List load balancers in a project.", "x-stackit-authorization": { "actions": [ "nlb.loadbalancer.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.loadbalancer" ] } } }, "post": { "description": "Create Load Balancer will create a load balancer.\n The default load balancing algorithm is round robin unless useSourceIpAddress in session persistence is enabled for a target pool then it is Maglev.", "operationId": "CreateLoadBalancer", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "region", "required": true, "schema": { "type": "string" } }, { "example": "2438ac3c-37eb-4902-adef-ed16b4431030", "in": "header", "name": "X-Request-ID", "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLoadBalancerPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadBalancer" } } }, "description": "OK" }, "400": { "description": "One or more fields are invalid." }, "401": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Unauthorized" }, "403": { "description": "this project_id is not allowed to try this API" }, "409": { "description": "load balancer already exists" }, "429": { "description": "maximum number of load balancing servers reached - please contact support to increase it" }, "500": { "description": "internal error - please retry again later or contact support if the issue persists" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } }, "description": "Default error response" } }, "summary": "Create a load balancer in a project", "x-stackit-authorization": { "actions": [ "nlb.loadbalancer.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.loadbalancer" ] } } } }, "/v2/projects/{projectId}/regions/{region}/load-balancers/{name}": { "delete": { "description": "DeleteLoadBalancer will delete a given load balancer.", "operationId": "DeleteLoadBalancer", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "region", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLoadBalancerResponse" } } }, "description": "OK" }, "400": { "description": "One or more fields are invalid." }, "401": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Unauthorized" }, "403": { "description": "this project_id is not allowed to try this API" }, "500": { "description": "internal error - please retry again later or contact support if the issue persists" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } }, "description": "Default error response" } }, "summary": "Delete a given load balancer in a project.", "x-stackit-authorization": { "actions": [ "nlb.loadbalancer.delete" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.loadbalancer" ] } } }, "get": { "description": "Get Load Balancer will get a single load balancer of a project. This contains all the information set during\n creation or updates. Additionally, it will have information about the state of the load balancer in the form\n of a status field and error description feedback.", "operationId": "GetLoadBalancer", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "region", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadBalancer" } } }, "description": "OK" }, "400": { "description": "One or more fields are invalid." }, "401": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Unauthorized" }, "403": { "description": "this project_id is not allowed to try this API" }, "404": { "description": "load balancer not found" }, "500": { "description": "internal error - please retry again later or contact support if the issue persists" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } }, "description": "Default error response" } }, "summary": "Get a single load balancer in a project.", "x-stackit-authorization": { "actions": [ "nlb.loadbalancer.get" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.loadbalancer" ] } } }, "put": { "description": "Update Load Balancer allows the change of listeners and target pools of an existing Load Balancer.\n The Load balancer resource version needs to be the current version to ensure concurrency safe updates.\n The default load balancing algorithm is round robin unless useSourceIpAddress in session persistence is enabled for a target pool then it is Maglev.", "operationId": "UpdateLoadBalancer", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "region", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLoadBalancerPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadBalancer" } } }, "description": "OK" }, "400": { "description": "One or more fields are invalid." }, "401": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Unauthorized" }, "403": { "description": "this project_id is not allowed to try this API" }, "409": { "description": "Conflict with current state" }, "500": { "description": "internal error - please retry again later or contact support if the issue persists" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } }, "description": "Default error response" } }, "summary": "Update a load balancer in a project.", "x-stackit-authorization": { "actions": [ "nlb.loadbalancer.update" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.loadbalancer" ] } } } }, "/v2/projects/{projectId}/regions/{region}/load-balancers/{name}/target-pools/{targetPoolName}": { "put": { "description": "ReplaceTargetPool will replace a specific target pool of a load balancer with new content.\n Useful to add/remove target servers. will update a load balancer.\n Only replaces the mentioned target pools and leaves others unchanged.\n Cannot be used to create or rename a target pool.", "operationId": "UpdateTargetPool", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "region", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "targetPoolName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTargetPoolPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetPool" } } }, "description": "OK" }, "400": { "description": "One or more fields are invalid." }, "401": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Unauthorized" }, "403": { "description": "this project_id is not allowed to try this API" }, "500": { "description": "internal error - please retry again later or contact support if the issue persists" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } }, "description": "Default error response" } }, "summary": "Update a single target pool of a load balancer in a project.", "x-stackit-authorization": { "actions": [ "nlb.targetpool.replace" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.loadbalancer" ] } } } }, "/v2/projects/{projectId}/regions/{region}/quota": { "get": { "description": "Retrieves the configured Network Load Balancer quota for the project. Limit can be changed via service request.", "operationId": "GetQuota", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "region", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetQuotaResponse" } } }, "description": "OK" }, "400": { "description": "One or more fields are invalid." }, "401": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Unauthorized" }, "403": { "description": "this projectId is not allowed to try this API" }, "500": { "description": "internal error - please retry again later or contact support if the issue persists" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } }, "description": "Default error response" } }, "summary": "Get the quota of Network Load Balancers in a project.", "x-stackit-authorization": { "actions": [ "nlb.quota.get" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.loadbalancer" ] } } } }, "/v2/regions/{region}/plans": { "get": { "description": "ListPlans returns for the configured service plans for a project.", "operationId": "ListPlans", "parameters": [ { "in": "path", "name": "region", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPlansResponse" } } }, "description": "OK" }, "400": { "description": "One or more fields are invalid." }, "401": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Unauthorized" }, "403": { "description": "this projectId is not allowed to try this API" }, "500": { "description": "internal error - please retry again later or contact support if the issue persists" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } }, "description": "Default error response" } }, "summary": "List available service plans.", "x-stackit-authorization": { "disabled": true } } } }, "security": [ { "bearerAuth": [] } ], "servers": [ { "url": "https://load-balancer.api.stackit.cloud", "variables": { "region": { "default": "global" } } } ] }