STstudio-saelix
Webhooks

Update webhook

Changed on

Updates webhook configuration. Requires admin role.

put/api/webhooks/{id}

Request

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/webhooks/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

Numeric resource ID.

Request body

namestring
stack_namestring
action'deploy' | 'restart' | 'stop' | 'start' | 'pull' | 'git-pull'
enabledboolean
node_idinteger

Retarget the webhook to a different node.

Response

Webhook updated.

successboolean required

Example response

{
  "success": true
}

Changes

  • d58cf9d6195bRevision changes
    • info

      removed the ADMIRAL_REQUIRED enum value from the response property for the response status

    • info

      removed the ADMIRAL_REQUIRED enum value from the response property for the response status

    • info

      removed the ADMIRAL_REQUIRED enum value from the response property for the response status

    • info

      removed the ADMIRAL_REQUIRED enum value from the response property for the response status

  • 3e94162e8e64Revision changes
    • warning

      the request property's maxLength was set to 100

    • info

      added the new optional request property

    • info

      added the new git-pull enum value to the request property