Harness

Harness File Store API

This contains APIs related to File Store in Harness

GitHub OpenAPI

Operations 15

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /ng/api/file-store List files and folders in the file store · List Files and Folders metadata #
Ask an LLM
“What files and folders are in my Harness file store?”
“Can I search the file store listing by name and page through it?”
Tell an agent
List files and folders in the file store for project {projectIdentifier}.
Search the file store listing for {searchTerm}.
POST /ng/api/file-store Create a file or folder with content · Create Folder or File including content #
Ask an LLM
“How do I upload a new config file into the file store?”
“Can I create a folder inside another folder in the file store?”
Tell an agent
Create a {type} named {name} under folder {parentIdentifier} in the file store.
Upload file {name} with content {content} into folder {parentIdentifier}.
POST /ng/api/file-store/yaml Create file or folder metadata from YAML · Creates File or Folder metadata via YAML #
Ask an LLM
“Can I define a file store entry's metadata in YAML instead of a form?”
“What does a YAML payload for a new file-store folder look like?”
Tell an agent
Create a file store entry from this YAML: {file}.
Register folder metadata via YAML {file} in project {projectIdentifier}.
GET /ng/api/file-store/{identifier} Get a file or folder's metadata · Get the Folder or File metadata #
Ask an LLM
“What metadata does the file store keep about one file?”
“Can I see who last modified a specific file-store entry?”
Tell an agent
Get metadata for file store entry {identifier}.
Show the tags and path of file {identifier} in project {projectIdentifier}.
PUT /ng/api/file-store/{identifier} Update a file or folder including content · Update Folder or File including content #
Ask an LLM
“How do I replace the contents of a file already in the file store?”
“Can I move a file to a different parent folder when I update it?”
Tell an agent
Replace the content of file {identifier} with {content}.
Rename file store entry {identifier} to {name} under folder {parentIdentifier}.
DELETE /ng/api/file-store/{identifier} Delete a file or folder · Delete File or Folder by identifier #
Ask an LLM
“How do I delete a file from the file store?”
“Can I force-delete a file even when pipelines still reference it?”
Tell an agent destructive · confirm first
Delete file store entry {identifier}.
Force-delete folder {identifier} with forceDelete {forceDelete}.
GET /ng/api/file-store/files/{identifier}/download Download a file from the file store · Download File #
Ask an LLM
“How can I download a file I stored in Harness?”
“Can I pull the raw file back down by its identifier?”
Tell an agent
Download file {identifier} from the file store.
Save a local copy of file store file {identifier}.
GET /ng/api/file-store/files/createdBy List users who created files · Get list of created by user details #
Ask an LLM
“Who has created files in our file store?”
“Can I get the list of file authors to use as a filter?”
Tell an agent
List the users who created files in the file store.
Show file creators for project {projectIdentifier}.
GET /ng/api/file-store/files/{scopedFilePath}/content Read file content by scoped path in the URL · Get file content of scopedFilePath #
Ask an LLM
“Can I read a file's contents using its scoped path in the URL?”
“How do I fetch the text of an account-scoped file by path?”
Tell an agent
Read the content of scoped file path {scopedFilePath}.
Show me what's in {scopedFilePath} using the path-in-URL endpoint.
POST /ng/api/file-store/files/content Read file content by path sent in the body · Get file content by file path #
Ask an LLM
“Can I get a file's content by posting its path as plain text in the request body?”
“Which endpoint returns file content when the path has characters awkward to put in a URL?”
Tell an agent
Fetch file content by posting the scoped path in the body for project {projectIdentifier}.
Read a file's text using the body-path content endpoint.
GET /ng/api/file-store/{identifier}/referenced-by List entities that reference a file · Get list of entities where file is referenced by queried entity type #
Ask an LLM
“Which pipelines or services reference a given file?”
“Can I check where a file is used before I delete it?”
Tell an agent
List entities that reference file {identifier}.
Show {entityType} entities using file {identifier}.
GET /ng/api/file-store/supported-entity-types List entity types that can reference files · Get the list of supported entity types for files #
Ask an LLM
“What kinds of entities can reference a file-store file?”
“Which entity types are supported for file references?”
Tell an agent
List supported file reference entity types for account {accountIdentifier}.
Show which entity types can use stored files.
POST /ng/api/file-store/files/filter Filter files by usage, creator, tags · Get filtered list of Files or Folders #
Ask an LLM
“Can I find files by their usage type, creator or tags?”
“How do I apply a saved filter to the file store?”
Tell an agent
Filter the file store to files with usage {fileUsage}.
Apply saved filter {filterIdentifier} to the file store with filter type {filterType}.
POST /ng/api/file-store/folder List a folder's immediate children · Get folder nodes at first level, not including sub-nodes #
Ask an LLM
“What's directly inside a folder, without walking every subfolder?”
“Can I browse the file store one folder level at a time?”
Tell an agent
Show the first-level contents of folder {identifier} named {name}.
Expand {type} node {identifier} one level.
PUT /ng/api/file-store/yaml/{identifier} Update file or folder metadata from YAML · Update File or Folder metadata via YAML #
Ask an LLM
“Can I change a file's name, description or tags using YAML?”
“Does the YAML update endpoint change file content or only metadata?”
Tell an agent
Update metadata of file store entry {identifier} from YAML {file}.
Apply this YAML metadata to folder {identifier}: {file}.

Documentation

📖
Documentation
https://apidocs.harness.io
📖
APIReference
https://apidocs.harness.io
📖
GettingStarted
https://developer.harness.io/docs/platform/automation/api/api-quickstart/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/authentication/harness-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/rate-limits/harness-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-file-store-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/scopes/harness-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/errors/harness-error-codes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/conventions/harness-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/conventions/harness-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/harness:harness-file-store-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

harness-file-store-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harness File Store API
  version: '1.0'
  description: The Harness Software Delivery Platform uses OpenAPI Specification v3.0.
  contact:
    name: API Support
    email: contact@harness.io
    url: https://harness.io/
  x-logo:
    url: https://mma.prnewswire.com/media/779232/Harnes_logo_horizontal.jpg?p=facebook
    altText: Harness
  termsOfService: https://harness.io/terms-of-use/
servers:
- url: https://app.harness.io
  description: Harness host URL
- url: https://{vanity}
  description: Vanity URL
  variables:
    vanity:
      default: app.harness.io
security:
- x-api-key: []
tags:


# --- truncated at 32 KB (141 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-file-store-api-openapi.yml