Skip to main content
Effective Date — May 7, 2026
As part of the IAM hierarchy simplification, a new format of the TIR APIs is now available. All endpoints that previously included /teams/:team_id segment will now follow a service-centric structure, with project_id now passed as a query parameter instead of a path segment. You can read more about this change

Update Gateway

Updates gateway configuration fields (name, description, environment).

PUT/gateway/{gateway_id}/

Path parameters

  • gateway_idPathintegerrequired

    Gateway ID

Query parameters

  • project_idQueryintegerrequired

    Project ID

  • locationQuerystringrequired

    Location

  • active_iamQueryintegeroptional

    Active IAM ID (To access contact person account) Find your Active IAM ID here

Request body

application/json

object
namestring

Updated gateway name.

exampleupdated-gateway
descriptionstring

Updated description.

exampleUpdated description
environmentstring

Updated environment tag.

examplestaging

Responses

200Gateway updated successfully.
object
codeinteger
example200
dataobject
errorsobject
messagestring
exampleSuccess