> ## Documentation Index > Fetch the complete documentation index at: https://gcore.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # List floating IPs ## OpenAPI ````yaml /api-reference/services_documented/cloud_api.yaml get /cloud/v1/floatingips/{project_id}/{region_id} openapi: 3.1.0 info: title: Gcore OpenAPI – Cloud API description: >- This OpenAPI is an aggregated OpenAPI specification that unifies all Gcore products into a single file. It covers Cloud, CDN, DNS, WAAP, DDoS Protection, Object Storage, Streaming, and FastEdge services. version: '2026-05-14T07:00:22.640261+00:00' servers: - url: https://api.gcore.com security: - APIKey: [] tags: - name: Bare Metal x-displayName: Bare Metal - name: Container as a Service x-displayName: Container as a Service - name: Cost Reports x-displayName: Cost Reports - name: DDoS Protection x-displayName: DDoS Protection - name: Everywhere Inference x-displayName: Everywhere Inference - name: Everywhere Inference Apps x-displayName: Everywhere Inference Apps - name: File Shares x-displayName: File Shares - name: Floating IPs x-displayName: Floating IPs - name: Function as a Service x-displayName: Function as a Service - name: GPU Bare Metal x-displayName: GPU Bare Metal - name: GPU Virtual x-displayName: GPU Virtual - name: IP Ranges x-displayName: IP Ranges - name: Images x-displayName: Images - name: Instances x-displayName: Instances - name: Load Balancers x-displayName: Load Balancers - name: Logging x-displayName: Logging - name: Managed Kubernetes x-displayName: Managed Kubernetes - name: Managed PostgreSQL x-displayName: Managed PostgreSQL - name: Networks x-displayName: Networks - name: Placement Groups x-displayName: Placement Groups - name: Projects x-displayName: Projects - name: Quotas x-displayName: Quotas - name: Regions x-displayName: Regions - name: Registry x-displayName: Registry - name: Reservations x-displayName: Reservations - name: Reserved IPs x-displayName: Reserved IPs - name: Routers x-displayName: Routers - name: SSH Keys x-displayName: SSH Keys - name: Secrets x-displayName: Secrets - name: Security Groups x-displayName: Security Groups - name: Snapshot Schedules x-displayName: Snapshot Schedules - name: Snapshots x-displayName: Snapshots - name: Tasks x-displayName: Tasks - name: User Actions x-displayName: User Actions - name: User Role Assignments x-displayName: User Role Assignments - name: Volumes x-displayName: Volumes paths: /cloud/v1/floatingips/{project_id}/{region_id}: get: tags: - Floating IPs summary: List floating IPs operationId: FloatingIPViewSet.get parameters: - in: path name: project_id required: true description: Project ID schema: description: Project ID example: 1 examples: - 1 title: Project Id type: integer - in: path name: region_id required: true description: Region ID schema: description: Region ID example: 1 examples: - 1 title: Region Id type: integer - in: query name: limit required: false description: Optional. Limit the number of returned items schema: default: 1000 description: Optional. Limit the number of returned items example: 1000 examples: - 1000 exclusiveMinimum: 0 maximum: 1000 title: Limit type: integer - in: query name: offset required: false description: >- Optional. Offset value is used to exclude the first set of records from the result schema: default: 0 description: >- Optional. Offset value is used to exclude the first set of records from the result example: 0 examples: - 0 minimum: 0 title: Offset type: integer - in: query name: status required: false description: >- Filter by floating IP status. DOWN - unassigned (available). ACTIVE - attached to a port (in use). ERROR - error state. schema: $ref: '#/components/schemas/FloatingIPStatus' description: >- Filter by floating IP status. DOWN - unassigned (available). ACTIVE - attached to a port (in use). ERROR - error state. examples: - DOWN - in: query name: tag_key required: false description: Optional. Filter by tag keys. ?`tag_key`=key1&`tag_key`=key2 schema: description: Optional. Filter by tag keys. ?`tag_key`=key1&`tag_key`=key2 example: - key1 - key2 examples: - - key1 - key2 items: description: >- Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character. example: my-tag examples: - my-tag maxLength: 255 minLength: 1 pattern: ^[^\s=]+$ type: string title: Tag Key type: array - in: query name: tag_key_value required: false description: Optional. Filter by tag key-value pairs. schema: contentMediaType: application/json contentSchema: patternProperties: ^[^\s=]+$: description: >- Tag value. Maximum 255 characters. Cannot contain tabs, newlines, empty string or start/end with whitespace. example: my-tag-value examples: - my-tag-value maxLength: 255 minLength: 1 pattern: ^[^ \t\n\r\f\v]([^\t\n\r\f\v]*[^ \t\n\r\f\v])?$ type: string propertyNames: description: >- Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character. examples: - my-tag maxLength: 255 minLength: 1 type: object description: Optional. Filter by tag key-value pairs. example: key: value examples: - key: value title: Tag Key Value type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FloatingIPDetailedCollectionSerializer' x-codeSamples: - lang: Python source: |- import os from gcore import Gcore client = Gcore( api_key=os.environ.get("GCORE_API_KEY"), # This is the default and can be omitted ) page = client.cloud.floating_ips.list( project_id=1, region_id=1, ) page = page.results[0] print(page.id) - lang: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/G-Core/gcore-go\"\n\t\"github.com/G-Core/gcore-go/cloud\"\n\t\"github.com/G-Core/gcore-go/option\"\n)\n\nfunc main() {\n\tclient := gcore.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Cloud.FloatingIPs.List(context.TODO(), cloud.FloatingIPListParams{\n\t\tProjectID: gcore.Int(1),\n\t\tRegionID: gcore.Int(1),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" components: schemas: FloatingIPStatus: enum: - ACTIVE - DOWN - ERROR title: FloatingIPStatus type: string FloatingIPDetailedCollectionSerializer: properties: count: description: Number of objects example: 1 examples: - 1 minimum: 0 title: Count type: integer results: description: Objects items: $ref: '#/components/schemas/FloatingIPDetailedSerializer' title: Results type: array required: - count - results title: FloatingIPDetailedCollectionSerializer type: object FloatingIPDetailedSerializer: properties: created_at: description: Datetime when the floating IP was created example: 2019-06-13T13:58:12+0000 examples: - 2019-06-13T13:58:12+0000 format: date-time title: Created At type: string creator_task_id: anyOf: - format: uuid4 type: string - type: 'null' description: Task that created this entity examples: - d1e1500b-e2be-40aa-9a4b-cc493fa1af30 title: Creator Task Id fixed_ip_address: anyOf: - format: ipvanyaddress type: string - type: 'null' description: IP address of the port the floating IP is attached to examples: - 192.168.10.15 title: Fixed Ip Address floating_ip_address: anyOf: - format: ipvanyaddress type: string - type: 'null' description: IP Address of the floating IP examples: - 172.24.4.34 title: Floating Ip Address id: description: Floating IP ID example: c64e5db1-5f1f-43ec-a8d9-5090df85b82d examples: - c64e5db1-5f1f-43ec-a8d9-5090df85b82d format: uuid4 title: Id type: string instance: anyOf: - $ref: '#/components/schemas/InstanceInFloatingSerializer' - type: 'null' description: Instance the floating IP is attached to loadbalancer: anyOf: - $ref: '#/components/schemas/LoadbalancerSerializer' - type: 'null' description: Load balancer the floating IP is attached to port_id: anyOf: - format: uuid4 type: string - type: 'null' description: Port ID examples: - ee2402d0-f0cd-4503-9b75-69be1d11c5f1 title: Port Id project_id: description: Project ID example: 1337 examples: - 1337 title: Project Id type: integer region: description: Region name example: Luxembourg 1 examples: - Luxembourg 1 title: Region type: string region_id: description: Region ID example: 7 examples: - 7 title: Region Id type: integer router_id: anyOf: - format: uuid4 type: string - type: 'null' description: Router ID examples: - 11005a33-c5ac-4c96-ab6f-8f2827cc7da6 title: Router Id status: anyOf: - $ref: '#/components/schemas/FloatingIPStatus' - type: 'null' description: >- Floating IP status. DOWN - unassigned (available). ACTIVE - attached to a port (in use). ERROR - error state. examples: - ACTIVE - DOWN - ERROR tags: description: >- List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values. example: - key: my-tag read_only: false value: my-tag-value examples: - - key: my-tag read_only: false value: my-tag-value items: $ref: '#/components/schemas/TagSerializer' title: Tags type: array task_id: anyOf: - format: uuid4 type: string - type: 'null' description: >- The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If `null`, the resource is not locked. examples: - a4eb4b29-048e-42f6-a5e1-2c18bc001c45 title: Task Id updated_at: description: Datetime when the floating IP was last updated example: 2019-06-13T13:58:12+0000 examples: - 2019-06-13T13:58:12+0000 format: date-time title: Updated At type: string required: - project_id - region_id - region - creator_task_id - fixed_ip_address - floating_ip_address - id - tags - port_id - router_id - status - task_id - created_at - updated_at - instance - loadbalancer title: FloatingIPDetailedSerializer type: object InstanceInFloatingSerializer: properties: addresses: additionalProperties: items: anyOf: - $ref: '#/components/schemas/InstanceFloatingAddressSerializer' - $ref: '#/components/schemas/InstanceFixedAddressShortSerializer' - $ref: '#/components/schemas/InstanceFixedAddressSerializer' type: array description: Map of `network_name` to list of addresses in that network title: Addresses type: object created_at: description: Datetime when instance was created example: '2023-11-29T10:56:49Z' examples: - '2023-11-29T10:56:49Z' format: date-time title: Created At type: string creator_task_id: description: Task that created this entity example: d1e1500b-e2be-40aa-9a4b-cc493fa1af30 examples: - d1e1500b-e2be-40aa-9a4b-cc493fa1af30 title: Creator Task Id type: string flavor: $ref: '#/components/schemas/BaseFlavorSerializer' description: Flavor id: description: Instance ID example: 6c6aa80f-7836-4dc2-a2ae-125e248be476 examples: - 6c6aa80f-7836-4dc2-a2ae-125e248be476 format: uuid4 title: Id type: string instance_description: anyOf: - type: string - type: 'null' description: Instance description examples: - Instance description title: Instance Description name: description: Instance name example: my-instance-1 examples: - my-instance-1 title: Name type: string project_id: description: Project ID example: 111 examples: - 111 title: Project Id type: integer region: description: Region name example: Luxembourg examples: - Luxembourg title: Region type: string region_id: description: Region ID example: 4 examples: - 4 title: Region Id type: integer security_groups: description: Security groups items: $ref: '#/components/schemas/NameSerializerPydantic' title: Security Groups type: array ssh_key_name: anyOf: - type: string - type: 'null' description: SSH key name assigned to instance examples: - my-ssh-key title: Ssh Key Name status: $ref: '#/components/schemas/InstanceStatus' description: Instance status examples: - ACTIVE tags: description: >- List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values. example: - key: my-tag read_only: false value: my-tag-value examples: - - key: my-tag read_only: false value: my-tag-value items: $ref: '#/components/schemas/TagSerializer' title: Tags type: array task_id: anyOf: - type: string - type: 'null' description: >- The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If `null`, the resource is not locked. examples: - null title: Task Id task_state: anyOf: - type: string - type: 'null' description: Task state examples: - null title: Task State vm_state: $ref: '#/components/schemas/InstanceVMState' description: Virtual machine state (active) examples: - active volumes: description: List of volumes items: $ref: '#/components/schemas/InstanceVolumeSerializer' title: Volumes type: array required: - id - name - created_at - status - vm_state - volumes - flavor - tags - instance_description - addresses - security_groups - ssh_key_name - creator_task_id - task_state - task_id - region - region_id - project_id title: InstanceInFloatingSerializer type: object LoadbalancerSerializer: properties: additional_vips: description: List of additional IP addresses items: $ref: '#/components/schemas/NetworkPortFixedIp' title: Additional Vips type: array admin_state_up: description: >- Administrative state of the resource. When set to true, the resource is enabled and operational. When set to false, the resource is disabled and will not process traffic. Defaults to true. example: true examples: - true - false title: Admin State Up type: boolean created_at: description: Datetime when the load balancer was created example: 2019-06-18T11:56:16+0000 examples: - 2019-06-18T11:56:16+0000 format: date-time title: Created At type: string creator_task_id: anyOf: - format: uuid4 type: string - type: 'null' default: null description: Task that created this entity examples: - 9f3ec11e-bcd4-4fe6-924a-a4439a56ad22 title: Creator Task Id ddos_profile: anyOf: - $ref: '#/components/schemas/GetClientProfileSerializer' - type: 'null' default: null description: Loadbalancer advanced DDoS protection profile. examples: - fields: - base_field: 10 default: null description: ARK server ports. Valid port values are in range 1000-65535 field_type: null field_value: - 45046 - 45047 id: 11 name: ARK Ports required: true validation_schema: items: maximum: 65535 minimum: 1000 type: integer minItems: 1 type: array value: null id: 0 options: active: true bgp: true profile_template: description: test client profile template fields: - default: null description: >- ARK server ports. Valid port values are in range 1000-65535 field_type: null id: 11 name: ARK Ports required: true validation_schema: items: maximum: 65535 minimum: 1000 type: integer minItems: 1 type: array id: 0 name: test_client_profile_template profile_template_description: ARK server ports. Valid port values are in range 1000-65535 protocols: - additionalProp1: string additionalProp2: string additionalProp3: string site: ED status: error_description: '' status: Updated flavor: anyOf: - $ref: '#/components/schemas/LbFlavorSerializer' - type: 'null' default: null description: Load balancer flavor (if not default) examples: - flavor_id: 1d276f53-2834-4855-9859-aa922f073055 flavor_name: lb1-1-2 ram: 2048 vcpus: 1 floating_ips: description: List of assigned floating IPs items: $ref: '#/components/schemas/FloatingIPSerializer' title: Floating Ips type: array id: description: Load balancer ID example: e8ab1be4-1521-4266-be69-28dad4148a30 examples: - e8ab1be4-1521-4266-be69-28dad4148a30 format: uuid4 title: Id type: string listeners: description: Load balancer listeners items: $ref: '#/components/schemas/ListenerSerializer' title: Listeners type: array logging: anyOf: - $ref: '#/components/schemas/LoggingOutSerializer' - type: 'null' default: null description: Logging configuration examples: - destination_region_id: 1 enabled: true retention_policy: period: 45 topic_name: my-log-name name: description: Load balancer name example: lbaas_test_lb examples: - lbaas_test_lb pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$ title: Name type: string operating_status: $ref: '#/components/schemas/OperatingStatusEnum' description: Load balancer operating status preferred_connectivity: $ref: '#/components/schemas/MemberConnectivity' default: L2 description: >- Preferred option to establish connectivity between load balancer and its pools members examples: - L2 - L3 project_id: description: Project ID example: 1337 examples: - 1337 title: Project Id type: integer provisioning_status: $ref: '#/components/schemas/ProvisioningStatusEnum' description: Load balancer lifecycle status region: description: Region name example: Luxembourg 1 examples: - Luxembourg 1 title: Region type: string region_id: description: Region ID example: 7 examples: - 7 title: Region Id type: integer stats: anyOf: - $ref: '#/components/schemas/LoadbalancerStatsSerializer' - type: 'null' default: null description: Statistics of load balancer. examples: - active_connections: 0 bytes_in: 34942398609 bytes_out: 304777113641 request_errors: 4 total_connections: 21095970 tags_v2: description: >- List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values. example: - key: my-tag read_only: false value: my-tag-value examples: - - key: my-tag read_only: false value: my-tag-value items: $ref: '#/components/schemas/TagSerializer' title: Tags V2 type: array task_id: anyOf: - format: uuid4 type: string - type: 'null' default: null description: >- The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If `null`, the resource is not locked. title: Task Id updated_at: anyOf: - format: date-time type: string - type: 'null' default: null description: Datetime when the load balancer was last updated examples: - 2019-06-18T11:57:00+0000 title: Updated At vip_address: anyOf: - format: ipvanyaddress type: string - type: 'null' default: null description: Load balancer IP address examples: - 5.5.5.5 title: Vip Address vip_fqdn: anyOf: - type: string - type: 'null' default: null description: Fully qualified domain name for the load balancer VIP examples: - 550e8400-e29b-41d4-a716-446655440000.lb.cloud.example.com title: Vip Fqdn vip_ip_family: anyOf: - $ref: '#/components/schemas/InterfaceIPFamily' - type: 'null' default: null description: Load balancer IP family examples: - ipv4 vip_port_id: anyOf: - format: uuid4 type: string - type: 'null' default: null description: The ID of the Virtual IP (VIP) port. examples: - 4177d1ef-f1c2-4e45-a531-3e05dfa6d848 title: Vip Port Id vrrp_ips: description: List of VRRP IP addresses items: $ref: '#/components/schemas/VRRPIP' title: Vrrp Ips type: array required: - project_id - region_id - region - id - name - operating_status - provisioning_status - created_at - tags_v2 - admin_state_up title: LoadbalancerSerializer type: object TagSerializer: description: >- A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values. properties: key: description: >- Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character. example: my-tag examples: - my-tag title: Key type: string read_only: description: If true, the tag is read-only and cannot be modified by the user example: false examples: - false title: Read Only type: boolean value: description: >- Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character. example: my-tag-value examples: - my-tag-value title: Value type: string required: - key - value - read_only title: TagSerializer type: object InstanceFloatingAddressSerializer: description: Schema for `floating` addresses. properties: addr: description: Address example: 10.0.0.17 examples: - 10.0.0.17 title: Addr type: string type: const: floating description: Type of the address example: fixed examples: - fixed title: Type type: string required: - addr - type title: Floating IP Address type: object InstanceFixedAddressShortSerializer: description: >- Schema for `fixed` addresses. This schema is used when listing instances. It omits the `subnet_name` and `subnet_id` fields. properties: addr: description: IP address example: 10.0.0.17 examples: - 10.0.0.17 title: Addr type: string interface_name: anyOf: - type: string - type: 'null' description: >- Interface name. This field will be `null` if `with_interfaces_name=true` is not set in the request when listing instances. It will also be `null` if the `interface_name` was not specified during instance creation or when attaching the interface. examples: - my-interface title: Interface Name type: const: fixed description: Type of the address example: fixed examples: - fixed title: Type type: string required: - addr - type - interface_name title: Fixed IP Address (short) type: object InstanceFixedAddressSerializer: description: >- Schema for `fixed` addresses. This schema is used when fetching a single instance. properties: addr: description: IP address example: 10.0.0.17 examples: - 10.0.0.17 title: Addr type: string interface_name: anyOf: - type: string - type: 'null' description: >- Interface name. This field will be `null` if `with_interfaces_name=true` is not set in the request when listing instances. It will also be `null` if the `interface_name` was not specified during instance creation or when attaching the interface. examples: - my-interface title: Interface Name subnet_id: description: >- The unique identifier of the subnet associated with this address. Included only in the response for a single-resource lookup (GET by ID). For the trunk subports, this field is always set. example: ba83aec4-7bc1-4979-b934-a11fc1d36cf3 examples: - ba83aec4-7bc1-4979-b934-a11fc1d36cf3 title: Subnet Id type: string subnet_name: description: >- The name of the subnet associated with this address. Included only in the response for a single-resource lookup (GET by ID). For the trunk subports, this field is always set. example: my-subnet examples: - my-subnet title: Subnet Name type: string type: const: fixed description: Type of the address example: fixed examples: - fixed title: Type type: string required: - addr - type - interface_name - subnet_name - subnet_id title: Fixed IP Address type: object BaseFlavorSerializer: properties: flavor_id: description: Flavor ID is the same as name example: g2-standard-32-64 examples: - g2-standard-32-64 title: Flavor Id type: string flavor_name: description: Flavor name example: g2-standard-32-64 examples: - g2-standard-32-64 title: Flavor Name type: string ram: description: RAM size in MiB example: 2048 examples: - 2048 title: Ram type: integer vcpus: description: Virtual CPU count. For bare metal flavors, it's a physical CPU count example: 1 examples: - 1 title: Vcpus type: integer required: - flavor_id - flavor_name - vcpus - ram title: BaseFlavorSerializer type: object NameSerializerPydantic: properties: name: description: Name. example: some_name examples: - some_name pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$ title: Name type: string required: - name title: NameSerializerPydantic type: object InstanceStatus: enum: - ACTIVE - BUILD - DELETED - ERROR - HARD_REBOOT - MIGRATING - PASSWORD - PAUSED - REBOOT - REBUILD - RESCUE - RESIZE - REVERT_RESIZE - SHELVED - SHELVED_OFFLOADED - SHUTOFF - SOFT_DELETED - SUSPENDED - UNKNOWN - VERIFY_RESIZE title: InstanceStatus type: string InstanceVMState: enum: - active - building - deleted - error - paused - rescued - resized - shelved - shelved_offloaded - soft-deleted - stopped - suspended title: InstanceVMState type: string InstanceVolumeSerializer: properties: delete_on_termination: description: Whether the volume is deleted together with the VM title: Delete On Termination type: boolean id: description: Volume ID title: Id type: string required: - id - delete_on_termination title: InstanceVolumeSerializer type: object NetworkPortFixedIp: properties: ip_address: description: IP address example: 127.0.0.1 examples: - 127.0.0.1 format: ipvanyaddress title: Ip Address type: string subnet_id: description: Subnet UUID example: 00000000-0000-4000-8000-000000000000 examples: - 00000000-0000-4000-8000-000000000000 format: uuid4 title: Subnet Id type: string required: - ip_address - subnet_id title: NetworkPortFixedIp type: object GetClientProfileSerializer: properties: fields: description: List of configured field values for the protection profile items: $ref: '#/components/schemas/ClientProfileFieldSerializer' title: Fields type: array id: description: Unique identifier for the DDoS protection profile example: 0 examples: - 0 title: Id type: integer options: $ref: '#/components/schemas/ProfileOptionsSerializer' description: Configuration options controlling profile activation and BGP routing examples: - active: true bgp: true profile_template: anyOf: - $ref: '#/components/schemas/ClientProfileTemplateSerializer' - type: 'null' description: Complete template configuration data used for this profile profile_template_description: anyOf: - type: string - type: 'null' description: >- Detailed description of the protection template used for this profile examples: - ARK server ports. Valid port values are in range 1000-65535 title: Profile Template Description protocols: anyOf: - items: $ref: '#/components/schemas/ProtocolsOnPortSerializer' type: array - type: 'null' description: List of network protocols and ports configured for protection examples: - - port: '80' protocols: - TCP - HTTP - port: '53' protocols: - UDP title: Protocols site: anyOf: - maxLength: 50 type: string - type: 'null' description: Geographic site identifier where the protection is deployed examples: - ED title: Site status: anyOf: - $ref: '#/components/schemas/DdosProfileStatusSerializer' - type: 'null' description: Current operational status and any error information for the profile examples: - error_description: '' status: Updated required: - id - options - site - protocols - status - profile_template_description - profile_template - fields title: GetClientProfileSerializer type: object LbFlavorSerializer: properties: flavor_id: description: Flavor ID is the same as name example: g2-standard-32-64 examples: - g2-standard-32-64 title: Flavor Id type: string flavor_name: description: Flavor name example: g2-standard-32-64 examples: - g2-standard-32-64 title: Flavor Name type: string ram: description: RAM size in MiB example: 2048 examples: - 2048 title: Ram type: integer vcpus: description: Virtual CPU count. For bare metal flavors, it's a physical CPU count example: 1 examples: - 1 title: Vcpus type: integer required: - flavor_id - flavor_name - vcpus - ram title: LbFlavorSerializer type: object FloatingIPSerializer: properties: created_at: description: Datetime when the floating IP was created example: 2019-06-13T13:58:12+0000 examples: - 2019-06-13T13:58:12+0000 format: date-time title: Created At type: string creator_task_id: anyOf: - format: uuid4 type: string - type: 'null' description: Task that created this entity examples: - d1e1500b-e2be-40aa-9a4b-cc493fa1af30 title: Creator Task Id fixed_ip_address: anyOf: - format: ipvanyaddress type: string - type: 'null' description: IP address of the port the floating IP is attached to examples: - 192.168.10.15 title: Fixed Ip Address floating_ip_address: anyOf: - format: ipvanyaddress type: string - type: 'null' description: IP Address of the floating IP examples: - 172.24.4.34 title: Floating Ip Address id: description: Floating IP ID example: c64e5db1-5f1f-43ec-a8d9-5090df85b82d examples: - c64e5db1-5f1f-43ec-a8d9-5090df85b82d format: uuid4 title: Id type: string port_id: anyOf: - format: uuid4 type: string - type: 'null' description: >- Port ID the floating IP is attached to. The `fixed_ip_address` is the IP address of the port. examples: - ee2402d0-f0cd-4503-9b75-69be1d11c5f1 title: Port Id project_id: description: Project ID example: 1337 examples: - 1337 title: Project Id type: integer region: description: Region name example: Luxembourg 1 examples: - Luxembourg 1 title: Region type: string region_id: description: Region ID example: 7 examples: - 7 title: Region Id type: integer router_id: anyOf: - format: uuid4 type: string - type: 'null' description: Router ID examples: - 11005a33-c5ac-4c96-ab6f-8f2827cc7da6 title: Router Id status: anyOf: - $ref: '#/components/schemas/FloatingIPStatus' - type: 'null' description: >- Floating IP status. DOWN - unassigned (available). ACTIVE - attached to a port (in use). ERROR - error state. examples: - ACTIVE - DOWN - ERROR tags: description: >- List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values. example: - key: my-tag read_only: false value: my-tag-value examples: - - key: my-tag read_only: false value: my-tag-value items: $ref: '#/components/schemas/TagSerializer' title: Tags type: array task_id: anyOf: - format: uuid4 type: string - type: 'null' description: >- The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If `null`, the resource is not locked. examples: - a4eb4b29-048e-42f6-a5e1-2c18bc001c45 title: Task Id updated_at: description: Datetime when the floating IP was last updated example: 2019-06-13T13:58:12+0000 examples: - 2019-06-13T13:58:12+0000 format: date-time title: Updated At type: string required: - project_id - region_id - region - creator_task_id - fixed_ip_address - floating_ip_address - id - tags - port_id - router_id - status - task_id - created_at - updated_at title: FloatingIPSerializer type: object ListenerSerializer: properties: id: description: Listener ID example: 43658ea9-54bd-4807-90b1-925921c9a0d1 examples: - 43658ea9-54bd-4807-90b1-925921c9a0d1 format: uuid4 title: Id type: string required: - id title: ListenerSerializer type: object LoggingOutSerializer: properties: destination_region_id: anyOf: - type: integer - type: 'null' description: ID of the region in which the logs will be stored examples: - 1 title: Destination Region Id enabled: description: Indicates if log streaming is enabled or disabled example: true examples: - true - false title: Enabled type: boolean retention_policy: anyOf: - $ref: '#/components/schemas/LaasIndexRetentionPolicyPydanticSerializer' - type: 'null' default: null description: Logs retention policy examples: - period: 45 topic_name: anyOf: - type: string - type: 'null' description: The topic name to stream logs to examples: - my-log-name title: Topic Name required: - enabled - destination_region_id - topic_name title: LoggingOutSerializer type: object OperatingStatusEnum: enum: - DEGRADED - DRAINING - ERROR - NO_MONITOR - OFFLINE - ONLINE title: OperatingStatusEnum type: string MemberConnectivity: enum: - L2 - L3 title: MemberConnectivity type: string ProvisioningStatusEnum: enum: - ACTIVE - DELETED - ERROR - PENDING_CREATE - PENDING_DELETE - PENDING_UPDATE title: ProvisioningStatusEnum type: string LoadbalancerStatsSerializer: properties: active_connections: description: Currently active connections example: 0 examples: - 0 title: Active Connections type: integer bytes_in: description: Total bytes received example: 34942398609 examples: - 34942398609 title: Bytes In type: integer bytes_out: description: Total bytes sent example: 304777113641 examples: - 304777113641 title: Bytes Out type: integer request_errors: description: Total requests that were unable to be fulfilled example: 4 examples: - 4 title: Request Errors type: integer total_connections: description: Total connections handled example: 21095970 examples: - 21095970 title: Total Connections type: integer required: - active_connections - bytes_in - bytes_out - request_errors - total_connections title: LoadbalancerStatsSerializer type: object InterfaceIPFamily: enum: - dual - ipv4 - ipv6 title: InterfaceIPFamily type: string VRRPIP: properties: ip_address: description: IP address example: 127.0.0.1 examples: - 127.0.0.1 format: ipvanyaddress title: Ip Address type: string role: $ref: '#/components/schemas/LoadBalancerInstanceRoleEnum' description: LoadBalancer instance role to which VRRP IP belong examples: - MASTER - BACKUP - STANDALONE subnet_id: description: Subnet UUID example: 00000000-0000-4000-8000-000000000000 examples: - 00000000-0000-4000-8000-000000000000 format: uuid4 title: Subnet Id type: string required: - ip_address - subnet_id - role title: VRRPIP type: object ClientProfileFieldSerializer: properties: base_field: description: ID of DDoS profile field example: 10 examples: - 10 title: Base Field type: integer default: anyOf: - maxLength: 100 type: string - type: 'null' description: Predefined default value for the field if not specified examples: - null title: Default description: anyOf: - maxLength: 255 type: string - type: 'null' description: >- Detailed description explaining the field's purpose and usage guidelines examples: - ARK server ports. Valid port values are in range 1000-65535 title: Description field_type: anyOf: - type: string - type: 'null' description: Data type classification of the field (e.g., string, integer, array) examples: - null title: Field Type field_value: description: Complex value for the DDoS profile field examples: - 45046 - 45047 title: Field Value id: description: Unique identifier for the DDoS protection field example: 11 examples: - 11 title: Id type: integer name: description: Human-readable name of the protection field example: ARK Ports examples: - ARK Ports maxLength: 30 title: Name type: string required: anyOf: - type: boolean - type: 'null' description: >- Indicates whether this field must be provided when creating a protection profile examples: - true title: Required validation_schema: description: >- JSON schema defining validation rules and constraints for the field value examples: - items: maximum: 65535 minimum: 1000 type: integer minItems: 1 type: array title: Validation Schema required: - id - name - description - field_type - required - default - validation_schema - field_value - base_field title: ClientProfileFieldSerializer type: object ProfileOptionsSerializer: properties: active: description: >- Controls whether the DDoS protection profile is enabled and actively protecting the resource example: true examples: - true title: Active type: boolean bgp: description: >- Enables Border Gateway Protocol (BGP) routing for DDoS protection traffic example: true examples: - true title: Bgp type: boolean required: - active - bgp title: ProfileOptionsSerializer type: object ClientProfileTemplateSerializer: properties: description: anyOf: - type: string - type: 'null' description: Detailed description explaining the template's purpose and use cases examples: - description title: Description fields: description: >- List of configurable fields that define the template's protection parameters items: $ref: '#/components/schemas/ClientProfileTemplateFieldSerializer' title: Fields type: array id: description: Unique identifier for the DDoS protection template example: 123 examples: - 123 title: Id type: integer name: description: Human-readable name of the protection template example: ICMP port examples: - ICMP port maxLength: 100 title: Name type: string required: - id - name - description - fields title: ClientProfileTemplateSerializer type: object ProtocolsOnPortSerializer: properties: port: description: Network port number for which protocols are configured example: '80' examples: - '80' title: Port type: string protocols: description: List of network protocols enabled on the specified port example: - TCP - HTTP examples: - - TCP - HTTP items: type: string title: Protocols type: array required: - port - protocols title: ProtocolsOnPortSerializer type: object DdosProfileStatusSerializer: properties: error_description: description: >- Detailed error message describing any issues with the profile operation example: An error occured while deleting profile examples: - An error occured while deleting profile title: Error Description type: string status: description: Current operational status of the DDoS protection profile example: Error Deleting examples: - Error Deleting maxLength: 30 minLength: 3 title: Status type: string required: - status - error_description title: DdosProfileStatusSerializer type: object LaasIndexRetentionPolicyPydanticSerializer: properties: period: anyOf: - exclusiveMinimum: 0 maximum: 1825 type: integer - type: 'null' description: Duration of days for which logs must be kept. examples: - 45 title: Period required: - period title: LaasIndexRetentionPolicyPydanticSerializer type: object LoadBalancerInstanceRoleEnum: enum: - BACKUP - MASTER - STANDALONE title: LoadBalancerInstanceRoleEnum type: string ClientProfileTemplateFieldSerializer: properties: default: anyOf: - maxLength: 100 type: string - type: 'null' description: Predefined default value for the field if not specified examples: - null title: Default description: anyOf: - maxLength: 255 type: string - type: 'null' description: >- Detailed description explaining the field's purpose and usage guidelines examples: - ARK server ports. Valid port values are in range 1000-65535 title: Description field_type: anyOf: - type: string - type: 'null' description: Data type classification of the field (e.g., string, integer, array) examples: - null title: Field Type id: description: Unique identifier for the DDoS protection field example: 11 examples: - 11 title: Id type: integer name: description: Human-readable name of the protection field example: ARK Ports examples: - ARK Ports maxLength: 30 title: Name type: string required: anyOf: - type: boolean - type: 'null' description: >- Indicates whether this field must be provided when creating a protection profile examples: - true title: Required validation_schema: description: >- JSON schema defining validation rules and constraints for the field value examples: - items: maximum: 65535 minimum: 1000 type: integer minItems: 1 type: array title: Validation Schema required: - id - name - description - field_type - required - default - validation_schema title: ClientProfileTemplateFieldSerializer type: object securitySchemes: APIKey: description: >- API key for authentication. Make sure to include the word `apikey`, followed by a single space and then your token. Example: `apikey 1234$abcdef` type: apiKey in: header name: Authorization ````