Skip to content

About the REST-API

Coscine offers an Application Programming Interface (API) for the automization of workflows.


You can interact with Coscine via a REST API (REpresentational State Transfer). For this purpose you need an access token. The process of creating an access token in your user profile is described in Access Token.

To become familiar with API functions and how to use them you should take a look at the documentation of the specific endpoints. There you are able to test certain functions with custom parameters.

API Struktur

Endpoint Description Link
Admin This API provides endpoints for coscine admin utilities. Admin
BlobApi The BlobApi handles the interaction with binary large objects in the Coscine environment. BlobApi
Metadata This api provides methods for interacting with metadata. Metadata
Notices This project provides the Rest Api for dealing with markdown files. Notices
Organization This api provides methods for interacting with organizations. Organization
Pid This api handles the request for the public pid page. Pid
Project This api provides methods to access, create and update project information. Project
Resources This api provides methods for interacting with resources. Resources
Search API for the search. Search
STS This projects provides the funtionality of a secure token service for the Coscine platform. Token
Token This Api handles the Token management. Token
TreeApi The TreeApi handles the retrieving or storing metadata to a certain path. TreeApi
User This api provides methods to access and update user information. Project

Bindings for various programming languages

You can use the Coscine REST API with a variety of programming languages. A client library in the Python programming language is currently actively maintained by the Coscine userbase:

Coscine Python SDK

Please contact us, if you have written any Tutorial for Coscine on your own! We'd love to share your Tutorials with the Coscine Community on GitLab. Coscine and its users profit directly from the contributions of the Open Source Community. Together we can strive for more - therefore you should not hesitate to make your work public if it does not put you at a disadvantage.