Gateways

Changed on
patch/api/v3/gateways/{gatewayId}

Request

  • Base URL
    https://us.infisical.com
  • URL
    https://us.infisical.com/api/v3/gateways/{gatewayId}
  • Auth
    none declared

Path parameters

gatewayIdstring uuid required

Request body

namestring

New name for the gateway. Renaming does not affect the gateway's ID, so resources referencing it keep working.

Response

Default Response

idstring uuid required
identityIdstring uuid nullable
relayIdstring uuid nullable
namestring required
createdAtstring date-time required
updatedAtstring date-time required
heartbeatstring date-time nullable
heartbeatTTLnumber nullable
directAddressstring nullable
directHeartbeatstring date-time nullable
canRevokeboolean required

Changes

  • b1861c910818Revision changes
    • breaking

      removed the required property /// from the response with the status

    • warning

      removed the request property //

  • 1c99090073f3Revision changes
    • info

      added the new optional request property