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 Secrets API

This contains APIs related to Secrets as defined in Harness

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

Tagged areas include Secrets. 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 14 operations across 11 paths, and defines 129 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}.

14 operations 11 paths 129 schemas 1 DELETE4 GET6 POST3 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 Secrets 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 14

Across 11 paths, the API surfaces 14 operations — 1 DELETE, 4 GET, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Secrets 14

This contains APIs related to Secrets as defined in Harness

GET
/ng/api/v2/secrets/count
Count secrets for scope
countSecretsForScope 2 params → 400404500
GET
/ng/api/v2/secretsdeprecated
Fetches the list of Secrets corresponding to the request's filter criteria
listSecretsV2 15 params → 400404500default
POST
/ng/api/v2/secrets
Creates a Secret at given Scope
postSecret 4 params body → 400404500default
POST
/ng/api/v2/secrets/files
Creates a Secret File
postSecretFileV2 4 params body → 400404500default
POST
/ng/api/v2/secrets/yamldeprecated
Creates a secret via YAML
postSecretViaYaml 4 params body → 400404500default
GET
/ng/api/v2/secrets/{identifier}
Get the Secret by ID and Scope
getSecretV2 4 params → 400404500default
PUT
/ng/api/v2/secrets/{identifier}
Updates the Secret by ID and Scope
putSecret 4 params body → 400404500default
DELETE
/ng/api/v2/secrets/{identifier}
Deletes Secret by ID and Scope
deleteSecretV2 5 params → 400404500default
POST
/ng/api/v2/secrets/list/secrets
Fetches the list of Secrets corresponding to the request's filter criteria
listSecretsV4 7 params body → 400404500default
POST
/ng/api/v2/secrets/list
Fetches the list of Secrets corresponding to the request's filter criteria
listSecretsV3 8 params body → 400404500default
PUT
/ng/api/v2/secrets/files/{identifier}
Updates the Secret file by ID and Scope
putSecretFileV2 4 params body → 400404500default
PUT
/ng/api/v2/secrets/{identifier}/yaml
Updates the Secret by ID and Scope via YAML
putSecretViaYaml 4 params body → 400404500default
POST
/ng/api/v2/secrets/validate
Validates Secret with the provided ID and Scope
validateSecret 4 params body → 400404500default
GET
/ng/api/v2/secrets/validateUniqueIdentifier/{identifier}
Checks whether the identifier is unique or not
validateSecretIdentifierIsUnique 4 params → 400404500default

Schemas 129

The contract defines 129 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.

SecretResourceFilter
object
This has the filter information for the Secret in Harness.
6 properties
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
Error1
object
This is Error entity as defined in Harness
7 properties
DescriptorProtoOrBuilder
object
31 properties
ParserFieldDescriptorProto
object
CvDescriptorProto
object
36 properties
Location
object
19 properties
ResponseDTOPageResponseSecretResponse
object
4 properties
FeatureSupport
object
14 properties
ParserPolicyMetadata
object
ResponseDTOSecretResponse
object
4 properties
ParserFeatureSupport
object
ExtensionRangeOrBuilder
object
10 properties
MessageOptionsOrBuilder
object
16 properties
TemplateDescriptorProtoOrBuilder
object
32 properties
OneofOptionsOrBuilder
object
11 properties
FieldDescriptorProtoOrBuilder
object
23 properties
SecretValidationMetaData
object
1 property 1 required
ReservedRangeOrBuilder
object
8 properties
SecretSpec1
object
This has details of the Secret defined in Harness.
2 properties 1 required
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
ServiceOptionsOrBuilder
object
12 properties
ServiceDescriptorProto
object
16 properties
SecretResponse1
object
This has details of the Secret along with its metadata.
5 properties 1 required
ParserMethodDescriptorProto
object
ParserOneofDescriptorProto
object
ParserMessageOptions
object
SecretRequestWrapper
object
1 property 1 required
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
SecretValidationResult
object
This has validation details for the Secret defined in Harness.
2 properties
FileDescriptorProto
object
38 properties
ParserMethodOptions
object
ParserExtensionRangeOptions
object
ParserServiceDescriptorProto
object
ServiceDescriptorProtoOrBuilder
object
13 properties
Message
object
8 properties
ParserFeatureSet
object
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
Secret1
object
This is details of the secret entity defined in Harness.
8 properties 4 required
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
SecretFilterProperties
object
Properties of the Secret Filter defined in Harness
8 properties
EnumOptions
object
18 properties
EnumValueOptionsOrBuilder
object
15 properties
EditionDefault
object
12 properties
FileDescriptor
object
12 properties
ResponseDTOSecretValidationResult
object
4 properties
OneofDescriptorProtoOrBuilder
object
10 properties
MessageOptions
object
20 properties
FileOptionsOrBuilder
object
40 properties
ParserFileOptions
object
ValidationError
object
2 properties
ParserEnumReservedRange
object
ParserNamePart
object
NamePartOrBuilder
object
9 properties
CvDeclaration
object
16 properties
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
PageResponseSecretResponse
object
8 properties
Parser
object
PolicyMetadataOrBuilder
object
28 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-secrets-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 Secrets 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.