Update a workspace variable

Update the workspace variable value with this key.

Request schema

Path parameters

workspace_id

integerrequired

ID of the workspace

variable_key

stringrequired

Key of the variable

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Request

value

string | integer | booleanrequired

Http + 1.1

PUT

https://app.getcensus.com/api/v1/workspaces/{workspace_id}/application_variables/{variable_key}

PUT /api/v1/workspaces/{workspace_id}/application_variables/{variable_key} HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Content-Type: application/json
Host: app.getcensus.com
Content-Length: 23

{
  "value": "string"
}

Responses

200

Successfully updated workspace variable.

400

Bad Request

401

Invalid credentials for the requested resource.

403

The feature you're trying to use is not available for your organization.

404

Resource not found.

`200`

status

stringrequired

The outcome of the update request

enum:

"updated"

data

objectrequired

The key, value, and secret status of a workspace variable

key

stringrequired

Keys cannot contain whitespaces

value

string | integer | booleanrequired

secret

booleanrequired

Whether this variable contains secret or sensitive information, like a password. Secret variables can only be used in secret connection credentials.

`400`

status

string

The outcome of the request

enum:

"error"

message

string

The reason the request failed

example:

Cannot update a variable's 'secret' attribute once set. Please reach out to support if you need to do so.

`401`

status

integer

HTTP status code.

enum:

"401"

`403`

status

integer

HTTP status code.

enum:

"403"

message

string

Error message.

example:

The feature you're trying to use is not available for your organization.

`404`

status

integer

HTTP status code.

enum:

"404"

{
  "status": "updated",
  "data": {
    "key": "string",
    "value": "string",
    "secret": true
  }
}