The API allows developers to build applications that communicate with tinyPM using JSON messages over HTTP.

You can send requests using all HTTP methods (GET, POST, PUT, DELETE) to control most of tinyPM resources. Your application can be written in any language like Java, Javascript, Ruby, C#, Groovy, PHP, Python and more.

Token-based authentication

Every API request must include the HTTP header apiToken. Here is an example of a request:

GET /api/project/1 HTTP/1.1
Accept: */*
apiToken: 73a15bce28140dec315f8bf344ab97cc26802a41

The token:

  • is bound to your tinyPM instance and not to any particular user
  • never expires
  • can be found in the Application Settings -> API
  • is a long hash like 73a15bce28140dec315f8bf344ab97cc26802a41