Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Terrain Discovery Environment API Filesystem API

iRODS filesystem operations - browse, create, move, delete files and directories

Terrain Discovery Environment API Filesystem API is one of 9 APIs that Terrain Discovery Environment API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Filesystem. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 10 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 2026.04.

Requests are made against a single base URL, https://de.cyverse.org/terrain.

10 operations 10 paths 12 schemas 5 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2026.04
Base URL
https://de.cyverse.org/terrain
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Terrain Discovery Environment API Filesystem API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (KeycloakBearer). An API key is passed in the header as X-Iplant-De-Jwt (JwtHeader). By default, every request must be authenticated.

  • KeycloakBearer — Bearer JWT token obtained from Keycloak via /terrain/token/keycloak
  • JwtHeader — Signed JWT token passed in the X-Iplant-De-Jwt header

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 5 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Filesystem 10

iRODS filesystem operations - browse, create, move, delete files and directories

GET
/secured/filesystem/directory
List Directory
ListDirectory 5 params → 200
POST
/secured/filesystem/directory/create
Create Directory
CreateDirectory body → 200
GET
/secured/filesystem/root
Get Root Directory
GetRootDirectory → 200
GET
/secured/filesystem/stat
Get File Stats
GetFileStats 1 param → 200
GET
/secured/filesystem/exists
Check Path Exists
CheckPathExists 1 param → 200
POST
/secured/filesystem/move
Move Files
MoveFiles body → 200
POST
/secured/filesystem/rename
Rename File
RenameFile body → 200
POST
/secured/filesystem/delete
Delete Files
DeleteFiles body → 200
POST
/secured/filesystem/delete-contents
Empty Trash
EmptyTrash → 200
GET
/secured/filesystem/search
Search Filesystem
SearchFilesystem 4 params → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are FileSystemObject (8 properties), DirectoryListing (7 properties), FileStats (6 properties), SearchResults (3 properties). Each schema is shown below with its type and property counts.

DeleteRequest
object
1 property 1 required
MoveResponse
object
2 properties
CreateDirectoryRequest
object
1 property 1 required
PathExistence
object
1 property
DirectoryListing
object
7 properties
SearchResults
object
3 properties
DeleteResponse
object
1 property
FileSystemObject
object
8 properties
RenameRequest
object
2 properties 2 required
FileStats
object
6 properties
RootListing
object
1 property
MoveRequest
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

terrain-discovery-environment-api-filesystem-api-openapi.yml Raw ↑

Other APIs Terrain Discovery Environment API publishes across the network.

Terrain Discovery Environment API Analyses API
Terrain Discovery Environment API Apps API
Terrain Discovery Environment API Authentication API
Terrain Discovery Environment API Identifiers API
Terrain Discovery Environment API Metadata API
Terrain Discovery Environment API Notifications API
Terrain Discovery Environment API Search API
Terrain Discovery Environment API Sharing API