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

Job submission, monitoring, and management

Terrain Discovery Environment API Analyses 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 Analyses. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 3 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.

5 operations 3 paths 3 schemas 1 DELETE2 GET2 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 Analyses 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 5

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

Analyses 5

Job submission, monitoring, and management

GET
/secured/analyses
List Analyses
ListAnalyses 4 params → 200
POST
/secured/analyses
Submit Analysis
SubmitAnalysis body → 200
GET
/secured/analyses/{analysis-id}
Get Analysis
GetAnalysis 1 param → 200
DELETE
/secured/analyses/{analysis-id}
Delete Analysis
DeleteAnalysis 1 param → 200
POST
/secured/analyses/{analysis-id}/stop
Stop Analysis
StopAnalysis 1 param → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Analysis (9 properties), AnalysisSubmission (6 properties), AnalysisList (3 properties). Each schema is shown below with its type and property counts.

AnalysisList
object
3 properties
Analysis
object
9 properties
AnalysisSubmission
object
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Terrain Discovery Environment API publishes across the network.

Terrain Discovery Environment API Apps API
Terrain Discovery Environment API Authentication API
Terrain Discovery Environment API Filesystem 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