HTTP Checks

Changed on
post/projects/{project_id}/http-checks

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/http-checks
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Project ID

Request body

credentialstring nullable
enabledboolean
env_var_idinteger nullable
interval_secondsinteger
kind'http' | 'local'

What a stored check does: HTTP checks call an issuer; local checks read expiring items (certificates, SSH certificates, OpenPGP keys, kubeconfigs, JWTs) on this host and never transmit the value.

namestring required
secret_idinteger nullable

Project secret to check. HTTP checks may only send a secret to the provider its value is recognized as; local checks never send it.

Response

Success

automatic_providerstring nullable
enabledboolean required
env_var_idinteger nullable
idinteger required
interval_secondsinteger required
kind'http' | 'local' required

What a stored check does: HTTP checks call an issuer; local checks read expiring items (certificates, SSH certificates, OpenPGP keys, kubeconfigs, JWTs) on this host and never transmit the value.

last_checked_atstring date-time nullable
namestring required
next_check_atstring date-time required
project_idinteger required
secret_idinteger nullable

Changes