Skip to main content

Update Password

PUT/api/v1/nodes/{node_id}/actions/

Path parameters

  • node_idPathstringrequired

    Path parameter node_id.

Query parameters

  • project_idQuerystringoptional

    Identifier of the project to scope the request to. Optional; if omitted, the account's default project is used.

    • optional
    • if omitted, the request is applied to the default project
    example{{project_id}}
  • apikeyQuerystringoptional

    API key used to authenticate the request

    • required
    • must be a non-empty string
    example{{api_key}}
  • locationQuerystringoptional

    Location identifier for the password update request

    • must be a non-empty string
    • URL-encoded
    example{{location}}

Request body

application/json

object
typestring

Action identifier for updating a password

exampleupdate_password
  • must be the string "update_password"
passwordstring

New password for the user

exampleHello@1234567890
  • must be a non-empty string
  • minimum length 8 characters
  • maximum length 64 characters
  • must include at least one uppercase letter, one lowercase letter, one digit, and one special character

Responses

200Successful response
object
codeinteger

HTTP status code indicating the result of the password update request

example200
  • must be an integer
  • must be a valid HTTP status code (e.g., 200 for success)
dataobject
errorsobject
messagestring

Status message indicating the result of the password update

exampleSuccess
  • must be a non-empty string
  • max length 100 characters