API

Listof APIs

A detailed list of all possible API methods can be found here. In addition to the structure of the input parameters, the structure of the return and possible error codes are also displayed. If you want to integrate the interface in a client application, you can also use the Export > Client SDK button in the upper right corner to automatically generate a template for easier implementation.

Table API <> Scope

In the following table you can see which scopes are required to run which API to simplify the creation and scheduling of user accounts and credentials.

Warning

The scopes are not supersets of each other. I.e. the scope “admin” does not contain the scope “read”. If a credential should have all rights, then all scopes must be assigned to this credential.

Title

Method	API	Scope
POST	/api/v0/auth/users	admin
PUT	/api/v0/auth/users/{username}/status	admin
POST	/api/v0/auth/users/{username}/credentials	admin
PUT	/api/v0/auth/users/{username}/credentials/{keyid}/status	admin
PUT	/api/v0/auth/users/{username}/credentials/{keyid}/scopes/{scope}	admin
POST	/api/v0/registry/arcs/{arc_id}	write
POST	/api/v0/registry/arcs/{arc_id}/{arc_version}	write
POST	/api/v0/registry/arcs/{arc_id}/{arc_version}/investigation	write
POST	/api/v0/webhook	webhook
POST	/api/v0/registry/query	read
GET	/api/v0/auth/users	admin
GET	/api/v0/auth/users/{username}	admin
GET	/api/v0/auth/users/{username}/credentials	admin
GET	/api/v0/registry/arcs/{arc_id}	read
GET	/api/v0/registry/arcs/{arc_id}/{arc_version}	read
GET	/api/v0/registry/arcs/{arc_id}/{arc_version1}/{arc_version2}	read
GET	/api/v0/registry/arcs/arc_id/{arc_version}/investigation	read
GET	/api/v0/registry/studies	read
GET	/api/v0/registry/investigations	read
GET	/api/v0/registry/persons	read
GET	/api/v0/registry/publications	read
GET	/api/v0/registry/arcs	read
GET	/api/v0/registry/assays	read
GET	/api/v0/registry/logs	read