Update an Elastic IP

PUT /elastic-ip/{id}

Path parameters

id string(uuid) Required

application/json

Body Required

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

Responses

200 application/json

200
Hide response attributes Show response attributes object
- id string(uuid)
  
  Operation ID
- reason string
  
  Operation failure reason
  
  Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.
- reference object
  
  Related resource reference
  
  Additional properties are allowed.
  
  Hide reference attributes Show reference attributes object
  
  id string(uuid)
  
  Reference ID
  
  link string
  
  Link to the referenced resource
  
  command string
  
  Command name
- message string
  
  Operation message
- state string
  
  Operation status
  
  Values are failure, pending, success, or timeout.

PUT /elastic-ip/{id}

curl \
 -X PUT https://api-ch-gva-2.exoscale.com/v2/elastic-ip/{id} \
 -H "Content-Type: application/json" \
 -d '{"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"}}'

Request examples

{
  "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"
  }
}

Response examples (200)

{
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  },
  "message": "string",
  "state": "failure"
}