How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Harness Variables API

This contains APIs related to Variables as defined in Harness.

Harness Variables API is one of 488 APIs that Harness publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Variables. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 12 operations across 6 paths, and defines 146 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.harness.io, https://{vanity}.

12 operations 6 paths 146 schemas 2 DELETE5 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.harness.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Harness Variables API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

  • x-api-key — API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Paths & Operations 12

Across 6 paths, the API surfaces 12 operations — 2 DELETE, 5 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Variables 12

This contains APIs related to Variables as defined in Harness.

GET
/ng/api/variables
Fetches the list of Variables
getVariableList 9 params → 400500default
PUT
/ng/api/variables
Updates the Variable
updateVariable 1 param body → 400500default
POST
/ng/api/variables
Creates a Variable
createVariable 1 param body → 400500default
GET
/ng/api/variables/{identifier}
Get the Variable by scope identifiers and variable identifier
getVariable 4 params → 400500default
DELETE
/ng/api/variables/{identifier}
Deletes Variable by ID
deleteVariable 4 params → 400500default
POST
/ng/api/variables/list
Get list of Variable by scope identifiers and variable identifiers
listVariable 9 params body → 400500default
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables
List workspace variables
variables#list-variables 4 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables
Create workspace variable
variables#create-variable 4 params body → 200400401403404408409423
DELETE
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables/{kind}/{key}
Destroy workspace variable
variables#destroy-variable 6 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables/{kind}/{key}
Show workspace variable
variables#show-variable 6 params → 200400401403404408409423
PUT
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables/{kind}/{key}
Update workspace variable
variables#update-variable 6 params body → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables/merged
Get variables, provider connectors, and variable files
variables#get-variables-and-providers 4 params → 200400401403404408409423

Schemas 146

The contract defines 146 schemas that model the data the API accepts and returns. The most detailed are FileOptions (44 properties), FileOptionsOrBuilder (40 properties), FileDescriptorProto (38 properties), CvDescriptorProto (36 properties). Each schema is shown below with its type and property counts.

GovernanceMetadata2
object
GovernanceMetadata for OPA evaluation
33 properties
ParserMessageLite
object
UninterpretedOption
object
20 properties
SortOrder
object
2 properties
FieldDescriptor
object
26 properties
ParserLocation
object
FieldOptionsOrBuilder
object
27 properties
EnumValueDescriptorProtoOrBuilder
object
11 properties
PolicySetMetadataOrBuilder
object
27 properties
ParserEnumValueDescriptorProto
object
ResponseDTOPageResponseVariableResponseDTO
object
4 properties
Error1
object
This is Error entity as defined in Harness
7 properties
DescriptorProtoOrBuilder
object
31 properties
VariableRequestDTO
object
1 property
ParserFieldDescriptorProto
object
VariableListRequestDTO
object
1 property
CvDescriptorProto
object
36 properties
Location
object
19 properties
FeatureSupport
object
14 properties
ParserPolicyMetadata
object
ParserFeatureSupport
object
ExtensionRangeOrBuilder
object
10 properties
MessageOptionsOrBuilder
object
16 properties
TemplateDescriptorProtoOrBuilder
object
32 properties
OneofOptionsOrBuilder
object
11 properties
FieldDescriptorProtoOrBuilder
object
23 properties
ReservedRangeOrBuilder
object
8 properties
CvDescriptor
object
14 properties
ExtensionRange
object
13 properties
ParserFileDescriptorProto
object
FileOptions
object
44 properties
CvPolicyMetadata
object
31 properties
OneofDescriptor
object
9 properties
ParserPolicySetMetadata
object
NamePart
object
12 properties
ParserReservedRange
object
ParserEnumOptions
object
ParserEditionDefault
object
PageResponseVariableResponseDTO
object
8 properties
ServiceOptionsOrBuilder
object
12 properties
ServiceDescriptorProto
object
16 properties
ResponseDTOVariableResponseDTO
object
4 properties
ParserMethodDescriptorProto
object
ParserOneofDescriptorProto
object
ParserMessageOptions
object
DeclarationOrBuilder
object
13 properties
ServiceOptions
object
16 properties
UninterpretedOptionOrBuilder
object
17 properties
OneofOptions
object
15 properties
ServiceDescriptor
object
7 properties
ParserExtensionRange
object
ParserUninterpretedOption
object
ParserFieldOptions
object
ResponseMessage
object
7 properties
FeatureSetOrBuilder
object
12 properties
ParserServiceOptions
object
Descriptor
object
14 properties
MethodDescriptor
object
11 properties
ParserOneofOptions
object
SourceCodeInfo
object
13 properties
LocationOrBuilder
object
16 properties
FieldDescriptorProto
object
26 properties
ParserDescriptorProto
object
OneofDescriptorProto
object
13 properties
EditionDefaultOrBuilder
object
9 properties
EnumReservedRangeOrBuilder
object
8 properties
FileDescriptorProto
object
38 properties
ParserMethodOptions
object
ParserExtensionRangeOptions
object
ParserServiceDescriptorProto
object
VariableDTO
object
8 properties 4 required
VariableResponseDTO
object
3 properties 1 required
ServiceDescriptorProtoOrBuilder
object
13 properties
ParserFeatureSet
object
Message
object
8 properties
MethodDescriptorProtoOrBuilder
object
16 properties
ByteString
object
2 properties
ParserMessage
object
ResponseDTOBoolean
object
4 properties
EnumOptionsOrBuilder
object
14 properties
EnumDescriptorProto
object
21 properties
ParserSourceCodeInfo
object
MethodOptionsOrBuilder
object
13 properties
PolicyMetadata1
object
31 properties
EnumValueDescriptorProto
object
14 properties
ParserEnumValueOptions
object
ParserEnumDescriptorProto
object
UnknownFieldSet
object
6 properties
EnumValueOptions
object
19 properties
MethodDescriptorProto
object
19 properties
TemplateDescriptorProto
object
36 properties
FeatureSet
object
16 properties
EnumValueDescriptor
object
8 properties
PolicySetMetadata1
object
30 properties
ExtensionRangeOptions
object
19 properties
ParserDeclaration
object
ParserGovernanceMetadata
object
EnumDescriptorProtoOrBuilder
object
18 properties
FeatureSupportOrBuilder
object
11 properties
EnumOptions
object
18 properties
EnumValueOptionsOrBuilder
object
15 properties
EditionDefault
object
12 properties
FileDescriptor
object
12 properties
ValidationError
object
2 properties
OneofDescriptorProtoOrBuilder
object
10 properties
MessageOptions
object
20 properties
FileOptionsOrBuilder
object
40 properties
ParserFileOptions
object
ParserEnumReservedRange
object
ParserNamePart
object
NamePartOrBuilder
object
9 properties
CvDeclaration
object
16 properties
VariableConfigDTO
object
2 properties 2 required
ExtensionRangeOptionsOrBuilder
object
15 properties
Failure
object
This is Failure entity as defied in Harness
5 properties
MethodOptions
object
17 properties
MessageLite
object
4 properties
FieldOptions
object
31 properties
EnumReservedRange
object
11 properties
ReservedRange
object
11 properties
EnumDescriptor
object
9 properties
ErrorMetadata2
object
This implements different error meta data objects
1 property
SourceCodeInfoOrBuilder
object
9 properties
Parser
object
PolicyMetadataOrBuilder
object
28 properties
IaCMPolicy
object
8 properties 8 required
IaCMEvaluation
object
The result of a single evaluation
12 properties 12 required
ShowWorkspaceVariableResponse
object
10 properties 10 required
GetVariablesAndProvidersResponse
object
4 properties 4 required
UpdateWorkspaceVariableResponse
object
1 property
IaCMError
object
6 properties 6 required
HarnessIacmWorkspacevariable
object
WorkspaceVariableResource is the representation for a single environment variable associated with a workspace.
10 properties 10 required
DestroyWorkspaceVariableResponse
object
1 property
VariableFilePermissions
object
2 properties 2 required
IaCMEvaluatedPolicy
object
5 properties 5 required
CreateWorkspaceVariableRequest
object
4 properties 4 required
ConnectorPermissions
object
1 property 1 required
VariablePermissions
object
4 properties 4 required
CreateWorkspaceVariableResponse
object
11 properties 10 required
ProviderConnectorWithPermissions
object
12 properties 10 required
VariableWithPermissions
object
14 properties 12 required
VariableFileWithPermissions
object
14 properties 8 required
PolicyViolationError
object
7 properties 6 required
IaCMEvaluationDetail
object
13 properties 13 required
UpdateWorkspaceVariableRequest
object
2 properties 2 required
WorkspaceVariableResourceCollection
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-variables-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
Harness Continuous Delivery and GitOps API
Harness Feature Management and Experimentation API
Harness Cloud Cost Management API
Harness Chaos Engineering API
Harness Security Testing Orchestration API
Harness Internal Developer Portal API
Harness Code Repository API
Harness Service Reliability Management API
Harness Infrastructure as Code Management API
Harness Supply Chain Security API
Harness Software Engineering Insights API
Where this information came from

This is an independent, third-party profile of Harness Variables API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.