Harness

variables

Variables Service handles the API for managing workspace variables.

list-variables variables

List all workspace variables.

Securityx-api-key
Request
path Parameters
org
required
string [ 1 .. 128 ] characters

Org is the organisation identifier.

Example: ai
project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

Example: b
workspace
required
string

Workspace is the resource workspace this variable is associated with.

Example: Et dolorem eum voluptas amet iusto maiores.
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 1
Responses
200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]
create-variable variables
Creates a new workspace variable


Securityx-api-key 
Request 
path Parameters
org
required
string  [ 1 .. 128 ] characters 
Org is the organisation identifier.


 
 Example:  u9
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


 
 Example:  f
workspace
required
string
Workspace is the resource workspace this variable is associated with.


 
 Example:  Voluptas rem et et rem.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  s22
Request Body schema: application/json
required
key
required
string  [ 1 .. 128 ] characters ^[a-zA-Z0-9_]+$
Key is the identifier for the secret.


 
kind
required
string
Kind is the classfcation of the variable.


 Enum: "env" "tf"  
value
required
string
Value is the value of the secret.


 
value_type
required
string
Type indecates the value type of the secret. In the case of secret this is a
reference to an item in the secret store


 Enum: "string" "secret"  
Responses 
200
OK response.


400
BadRequestError: Bad Request response.


401
UnauthorizedError: Unauthorized response.


403
ForbiddenError: Forbidden response.


404
NotFoundError: Not Found response.


408
TimeoutError: Request Timeout response.


409
ConflictError: Conflict response.


423
LockedError: Locked response.


499
ContextCancelledError:  response.


500
InternalServerError: Internal Server Error response.


502
BadGatewayError: Bad Gateway response.


post/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables
Request samples 
application/json
{
  • "key": "78x",
  • "kind": "env",
  • "value": "Delectus minus corporis quam maxime.",
  • "value_type": "secret"
}
Response samples 
application/json
{
  • "account": "mdq",
  • "created": 7681860421406842000,
  • "key": "ro",
  • "kind": "tf",
  • "org": "9d0",
  • "policy_evaluation": {
    },
  • "project": "54c",
  • "updated": 7949081983676615000,
  • "value": "Eos non dolor temporibus possimus fuga modi.",
  • "value_type": "string",
  • "workspace": "Nam magnam."
}
destroy-variable variables
Deletes the given workspace variable.


Securityx-api-key 
Request 
path Parameters
org
required
string  [ 1 .. 128 ] characters 
Org is the organisation identifier.


 
 Example:  l0e
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


 
 Example:  j2d
workspace
required
string
Workspace is the resource workspace this variable is associated with.


 
 Example:  Quos omnis aut.
kind
required
string
Kind is the classfcation of the variable.


 Enum: "env" "tf"  
 Example:  tf
key
required
string  [ 1 .. 128 ] characters ^[a-zA-Z0-9_]+$
Key is the identifier for the secret.


 
 Example:  6t
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  ra
Responses 
200
OK response.


400
BadRequestError: Bad Request response.


401
UnauthorizedError: Unauthorized response.


403
ForbiddenError: Forbidden response.


404
NotFoundError: Not Found response.


408
TimeoutError: Request Timeout response.


409
ConflictError: Conflict response.


423
LockedError: Locked response.


499
ContextCancelledError:  response.


500
InternalServerError: Internal Server Error response.


502
BadGatewayError: Bad Gateway response.


delete/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables/{kind}/{key}
Request samples 
Response samples 
application/json
{
  • "policy_evaluation": {
    }
}
show-variable variables
Show an individual workspace variable.


Securityx-api-key 
Request 
path Parameters
org
required
string  [ 1 .. 128 ] characters 
Org is the organisation identifier.


 
 Example:  lok
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


 
 Example:  r
workspace
required
string
Workspace is the resource workspace this variable is associated with.


 
 Example:  Architecto excepturi molestias nesciunt ut reprehenderit.
kind
required
string
Kind is the classfcation of the variable.


 Enum: "env" "tf"  
 Example:  env
key
required
string  [ 1 .. 128 ] characters ^[a-zA-Z0-9_]+$
Key is the identifier for the secret.


 
 Example:  mp
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  ps
Responses 
200
OK response.


400
BadRequestError: Bad Request response.


401
UnauthorizedError: Unauthorized response.


403
ForbiddenError: Forbidden response.


404
NotFoundError: Not Found response.


408
TimeoutError: Request Timeout response.


409
ConflictError: Conflict response.


423
LockedError: Locked response.


499
ContextCancelledError:  response.


500
InternalServerError: Internal Server Error response.


502
BadGatewayError: Bad Gateway response.


get/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables/{kind}/{key}
Request samples 
Response samples 
application/json
{
  • "account": "6a",
  • "created": 7680004233736311000,
  • "key": "7h8",
  • "kind": "env",
  • "org": "il",
  • "project": "ts",
  • "updated": 2757405817128166400,
  • "value": "Eum quasi non modi consectetur reiciendis consequatur.",
  • "value_type": "string",
  • "workspace": "Ut aut corporis ab cum consequatur ab."
}
update-variable variables
Updates the given workspace variable with new info.


Securityx-api-key 
Request 
path Parameters
org
required
string  [ 1 .. 128 ] characters 
Org is the organisation identifier.


 
 Example:  k
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


 
 Example:  7q7
workspace
required
string
Workspace is the resource workspace this variable is associated with.


 
 Example:  Consequatur enim magni.
kind
required
string
Kind is the classfcation of the variable.


 Enum: "env" "tf"  
 Example:  tf
key
required
string  [ 1 .. 128 ] characters ^[a-zA-Z0-9_]+$
Key is the identifier for the secret.


 
 Example:  0fx
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  3w
Request Body schema: application/json
required
value
required
string
Value is the value of the secret.


 
value_type
required
string
Type indecates the value type of the secret. In the case of secret this is a
reference to an item in the secret store


 Enum: "string" "secret"  
Responses 
200
OK response.


400
BadRequestError: Bad Request response.


401
UnauthorizedError: Unauthorized response.


403
ForbiddenError: Forbidden response.


404
NotFoundError: Not Found response.


408
TimeoutError: Request Timeout response.


409
ConflictError: Conflict response.


423
LockedError: Locked response.


499
ContextCancelledError:  response.


500
InternalServerError: Internal Server Error response.


502
BadGatewayError: Bad Gateway response.


put/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables/{kind}/{key}
Request samples 
application/json
{
  • "value": "Quia minima nemo aut harum vel.",
  • "value_type": "string"
}
Response samples 
application/json
{
  • "policy_evaluation": {
    }
}
➔ Next to Exemptions