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 File Store API

This contains APIs related to File Store in Harness

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

Tagged areas include File Store. 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 15 operations across 12 paths, and defines 31 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}.

15 operations 12 paths 31 schemas 1 DELETE7 GET5 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 File Store 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 15

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

File Store 15

This contains APIs related to File Store in Harness

GET
/ng/api/file-store
List Files and Folders metadata
listFilesAndFolders 9 params → 400500default
POST
/ng/api/file-store
Create Folder or File including content
create 3 params body → 400500default
POST
/ng/api/file-store/yaml
Creates File or Folder metadata via YAML
createViaYAML 3 params body → 400500default
GET
/ng/api/file-store/{identifier}
Get the Folder or File metadata
getFile 4 params → 400500default
PUT
/ng/api/file-store/{identifier}
Update Folder or File including content
update 4 params body → 400500default
DELETE
/ng/api/file-store/{identifier}
Delete File or Folder by identifier
deleteFile 5 params → 400500default
GET
/ng/api/file-store/files/{identifier}/download
Download File
downloadFile 4 params → 400500default
GET
/ng/api/file-store/files/createdBy
Get list of created by user details
getCreatedByList 3 params → 400500default
GET
/ng/api/file-store/files/{scopedFilePath}/contentdeprecated
Get file content of scopedFilePath
getFileContentUsingScopedFilePath 4 params → 400500default
POST
/ng/api/file-store/files/content
Get file content by file path
getFileContentUsingScopedFilePathV2 3 params body → 400500default
GET
/ng/api/file-store/{identifier}/referenced-by
Get list of entities where file is referenced by queried entity type
getReferencedBy 8 params → 400500default
GET
/ng/api/file-store/supported-entity-types
Get the list of supported entity types for files
getEntityTypes 1 param → 400500default
POST
/ng/api/file-store/files/filter
Get filtered list of Files or Folders
listFilesWithFilter 9 params body → 400500default
POST
/ng/api/file-store/folder
Get folder nodes at first level, not including sub-nodes
getFolderNodes 4 params body → 400500default
PUT
/ng/api/file-store/yaml/{identifier}
Update File or Folder metadata via YAML
updateViaYAML 4 params body → 400500default

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are File (16 properties), EntityReference (11 properties), PageFile (11 properties), FolderNode (8 properties). Each schema is shown below with its type and property counts.

ResponseDTOPageFile
object
4 properties
ResponseDTOString
object
4 properties
NGTag
object
This is the view of the tags of the entity.
2 properties 1 required
EntitySetupUsage
object
This is the view of the Entity Setup Usage defined in Harness
5 properties 1 required
SortOrder
object
2 properties
ResponseDTOPageResponseEntitySetupUsage
object
4 properties
TemplateEntityDetail
object
4 properties
ValidationError
object
2 properties
EntityReference
object
11 properties
FileStoreNode
object
This is the view of the file store node entity defined in Harness
7 properties 3 required
Error1
object
This is Error entity as defined in Harness
7 properties
FolderNode
object
This contains folder details
8 properties 3 required
FileStoreRequest
object
Wrapper object for File Store YAML operations containing a file field with File or Folder metadata.
1 property 1 required
PageResponseEntitySetupUsage
object
8 properties
Sort
object
3 properties
EmbeddedUserDetailsDTO
object
Updated by user details
2 properties
FilesFilterPropertiesDTO
object
Properties of the Files Filter defined in Harness
5 properties 1 required
ResponseDTOFile
object
4 properties
PageFile
object
11 properties
File
object
This is details of the File or Folder entity defined in Harness.
16 properties 3 required
ResponseDTOListEntityType
object
4 properties
Pageable
object
6 properties
ResponseDTOBoolean
object
4 properties
Failure
object
This is Failure entity as defied in Harness
5 properties
SetupUsageDetail
object
1 property 1 required
ErrorMetadata2
object
This implements different error meta data objects
1 property
ResponseMessage
object
7 properties
ResponseDTOSetEmbeddedUserDetailsDTO
object
4 properties
ReferencedByDTO
object
File referenced by other entity
2 properties
TemplateEntityGitMetadata
object
2 properties
ResponseDTOFolderNode
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-file-store-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 File Store 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.