List Elastic IPs

GET /elastic-ip

Responses

  • 200 application/json

    200

    Hide response attribute Show response attribute object
    • elastic-ips array[object]
      Hide elastic-ips attributes Show elastic-ips attributes object
      • id string(uuid)

        Elastic IP ID

      • ip string

        Elastic IP address

      • addressfamily string

        Elastic IP address family

        Values are inet4 or inet6.

      • cidr string

        Elastic IP cidr

      • description string

        Elastic IP description

        Maximum length is 255.

      • healthcheck object

        Elastic IP healthcheck

        Additional properties are allowed.

        Hide healthcheck attributes Show healthcheck attributes object
        • strikes-ok integer(int64)

          Number of attempts before considering the target healthy (default: 2)

          Minimum value is 1, maximum value is 20.

        • tls-skip-verify boolean

          Skip TLS verification

        • tls-sni string

          An optional domain or subdomain to check TLS against

          Minimum length is 1, maximum length is 255.

        • strikes-fail integer(int64)

          Number of attempts before considering the target unhealthy (default: 3)

          Minimum value is 1, maximum value is 20.

        • mode string Required

          Health check mode

          Values are tcp, http, or https.

        • port integer(int64) Required

          Health check port

          Minimum value is 1, maximum value is 65535.

        • uri string

          An endpoint to use for the health check, for example '/status'

          Minimum length is 1, maximum length is 255.

        • interval integer(int64)

          Interval between the checks in seconds (default: 10)

          Minimum value is 5, maximum value is 300.

        • timeout integer(int64)

          Health check timeout value in seconds (default: 2)

          Minimum value is 2, maximum value is 60.

      • labels object

        Resource labels

        Hide labels attribute Show labels attribute object
        • * string Additional properties
GET /elastic-ip 
curl \
 -X GET https://api-ch-gva-2.exoscale.com/v2/elastic-ip
Response examples (200) 
{
  "elastic-ips": [
    {
      "id": "string",
      "ip": "string",
      "addressfamily": "inet4",
      "cidr": "string",
      "description": "string",
      "healthcheck": {
        "strikes-ok": 42,
        "tls-skip-verify": true,
        "tls-sni": "string",
        "strikes-fail": 42,
        "mode": "tcp",
        "port": 42,
        "uri": "string",
        "interval": 42,
        "timeout": 42
      },
      "labels": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      }
    }
  ]
}