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

RWTH Aachen University Storage API

Provides endpoints for managing blob storage operations for project resources,such as checking existence and deleting files or folders.

RWTH Aachen University Storage API is one of 49 APIs that RWTH Aachen University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Storage. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.

This API exposes 4 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, https://coscine.rwth-aachen.de/coscine.

4 operations 2 paths 7 schemas 1 DELETE1 GET1 HEAD1 OPTIONS

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://coscine.rwth-aachen.de/coscine/api/
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

RWTH Aachen University Storage API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — JWT Authorization header using the Bearer scheme.

Paths & Operations 4

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

Storage 4

Provides endpoints for managing blob storage operations for project resources, such as checking existence and deleting files or folders.

HEAD
/api/v2/projects/{projectId}/resources/{resourceId}/storage/{encodedPath}
Checks if a file or folder exists at the specified path within the given project and resource.
HeadFileFromStorage 4 params → 200403404400
DELETE
/api/v2/projects/{projectId}/resources/{resourceId}/storage
Deletes a file or folder at the specified path within the given project and resource.
DeleteFileFromStorage 3 params → 204404
GET
/api/v2/projects/{projectId}/resources/{resourceId}/storage
Lists the contents of a directory in the storage tree.
ListFilesFromStorage 6 params → 200403404400
OPTIONS
/api/v2/projects/{projectId}/resources/{resourceId}/storage
Responds with the HTTP methods allowed for the endpoint.
2 params → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are FileTreeDto (10 properties), Pagination (6 properties), FileTreeDtoPagedResponse (5 properties), FileActionDto (2 properties). Each schema is shown below with its type and property counts.

TreeDataType
string
Represents the types of nodes within a hierarchical tree structure.
Pagination
object
Represents pagination information for a collection of items.
6 properties
FileTreeDto
object
Represents a Data Transfer Object (DTO) for a file within a tree structure, extending the base TreeDto.
10 properties
FileActionDto
object
Represents a Data Transfer Object (DTO) for file actions, including the URL and HTTP method.
2 properties
FileActionHttpMethod
string
Represents the possible HTTP methods associated with file actions.
FileTreeDtoPagedResponse
object
5 properties
FileActionsDto
object
Represents a Data Transfer Object (DTO) for a collection of file actions, including download action details.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rwth-aachen-university-storage-api-openapi.yml Raw ↑

Other APIs RWTH Aachen University publishes across the network.

RWTH Publications OAI-PMH
RWTH Single Sign-On (OAuth2 / OpenID Connect / Shibboleth)
RWTH Aachen University Admin API
RWTH Aachen University ApplicationProfile API
RWTH Aachen University Blob API
RWTH Aachen University DataHamsterReport API
RWTH Aachen University Discipline API
RWTH Aachen University Graph API
RWTH Aachen University GraphMetadata API
RWTH Aachen University GraphMetadataContent API
RWTH Aachen University Handle API
RWTH Aachen University Language API