Update a user-level variable which is created by current doer

PUT

/user/actions/variables/{variablename}

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

variablename

required

string

Name of the variable

Request Body

Media typeapplication/json

UpdateVariableOption defines the properties of the variable to update.

object

name

New name for the variable. If the field is empty, the variable name won’t be updated. Forgejo will convert it to uppercase.

string

value

required

Value of the variable to update. Special characters will be retained. Line endings will be normalized to LF to match the behaviour of browsers. Encode the data with Base64 if line endings should be retained.

string

Example^generated

{
  "name": "example",
  "value": "example"
}

Responses

201

Response when updating a variable

Media typeapplication/json

204

Response when updating a variable

Media typeapplication/json

400

APIError is error format response

Media typeapplication/json

APIError is an api error with a message

object

message

string

url

string

Example^generated

{
  "message": "example",
  "url": "example"
}

401

APIUnauthorizedError is a unauthorized error response

Media typeapplication/json

object

message

string

url

string

Example^generated

{
  "message": "example",
  "url": "example"
}

403

APIForbiddenError is a forbidden error response

Media typeapplication/json

object

message

string

url

string

Example^generated

{
  "message": "example",
  "url": "example"
}

404

APINotFound is a not found error response

Media typeapplication/json

object

errors

Array<string>

message

string

url

string

Example^generated

{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}