resources.configureHealth

POST

/resources/{resourceId}/health-policy

curl --request POST \
  --url https://example.com/api/resources/example/health-policy \
  --header 'Content-Type: application/json' \
  --data '{ "healthCheck": { "enabled": true, "type": "http", "intervalSeconds": 5, "timeoutSeconds": 5, "retries": 10, "startPeriodSeconds": 5, "http": { "method": "GET", "scheme": "http", "host": "localhost", "port": 1, "path": "/", "expectedStatusCode": 200, "expectedResponseText": "example" } } }'

Configures readiness and health checks used during verification. Public docs: /docs/resources/profiles/health-network/#resource-health-profile

Parameters

Path Parameters

resourceId

required

string

>= 1 characters

Request Body ^required

Media type application/json

object

healthCheck

required

object

enabled

boolean

default: true

type

string

default: http

Allowed value: http

intervalSeconds

integer

default: 5 > 0 <= 9007199254740991

timeoutSeconds

integer

default: 5 > 0 <= 9007199254740991

retries

integer

default: 10 > 0 <= 9007199254740991

startPeriodSeconds

integer

default: 5 <= 9007199254740991

http

object

method

string

default: GET

Allowed values: GET HEAD POST OPTIONS

scheme

string

default: http

Allowed values: http https

host

string

default: localhost >= 1 characters

port

integer

> 0 <= 65535

path

string

default: / >= 1 characters

expectedStatusCode

integer

default: 200 >= 100 <= 599

expectedResponseText

string

>= 1 characters

Responses

200

OK

Media type application/json

object

id

required

string

Example ^generated

{
  "id": "example"
}