HookEndpoints

Register an admission endpoint

The URL must be https without credentials. It is resolved and checked against private, loopback and link-local ranges on every call, and the connection is pinned to the validated address. The signing secret is returned once, in this response.

post/api/hook-endpoints

Request

  • Base URL: http://localhost:38200
  • URL: http://localhost:38200/api/hook-endpoints
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Request body

namestring required
urlstring uri required

https only, no credentials

enabledboolean
priorityinteger
opsstring[]
timeoutMsinteger
failMode'closed' | 'open'

What a failed call means on a single write.

bulkFailMode'open' | 'closed'

What a failed call means on a bulk write.

Response

Created endpoint plus its secret.

namestring required
urlstring uri required

https only, no credentials

enabledboolean
priorityinteger
opsstring[]
timeoutMsinteger
failMode'closed' | 'open'

What a failed call means on a single write.

bulkFailMode'open' | 'closed'

What a failed call means on a bulk write.

idinteger
contentGrant'text' | 'attributes' nullable
createdAtstring date-time
updatedAtstring date-time
secretstring

Example response

{
  "secret": "hks_…"
}

Changes

No recorded changes to this operation across all 1 revision of this API.