Harness

variables

Variables Service handles the API for managing workspace variables.

List workspace variables

List all workspace variables.

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

Org is the organisation identifier.

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

Project is the project identifier.

Example: t4
workspace
required
string

Workspace is the resource workspace this variable is associated with.

Example: Odio dignissimos non soluta.
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: d
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 workspace variable
Creates a new workspace variable


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


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


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


 
 Example:  Animi iusto quisquam placeat et.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  i4j
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": "in6",
  • "kind": "env",
  • "value": "Iure est quis beatae fugiat.",
  • "value_type": "string"
}
Response samples 
application/json
{
  • "account": "1",
  • "created": 336605109718172100,
  • "key": "e",
  • "kind": "tf",
  • "org": "kc",
  • "policy_evaluation": {
    },
  • "project": "x",
  • "updated": 878680806482977400,
  • "value": "Dicta dolorum sed sequi.",
  • "value_type": "secret",
  • "workspace": "Dicta autem quisquam atque ullam tempore eaque."
}
Destroy workspace variable
Deletes the given workspace variable.


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


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


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


 
 Example:  Quibusdam suscipit facere tempora molestias reiciendis eaque.
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:  k7
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  3
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 workspace variable
Show an individual workspace variable.


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


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


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


 
 Example:  Aperiam ipsum eum illum adipisci iure.
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:  5h
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  4
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": "9z",
  • "created": 5445892619505010000,
  • "key": "sm",
  • "kind": "tf",
  • "org": "lgc",
  • "project": "n",
  • "updated": 9001884500388421000,
  • "value": "Provident aut occaecati possimus sit adipisci est.",
  • "value_type": "secret",
  • "workspace": "Rerum distinctio ut similique itaque corporis."
}
Update workspace variable
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:  7
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


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


 
 Example:  Laudantium odio temporibus sint.
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:  5vd
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  pf
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": "Aut est praesentium doloremque minus.",
  • "value_type": "secret"
}
Response samples 
application/json
{
  • "policy_evaluation": {
    }
}
➔ Next to Exemptions