[API 2.0] API reference

A brief information how to use Woodpecker API 2.0

This documentation helps you implement REST Woodpecker API 2.0, which:

  • uses a JSON format,
  • is stateless,
  • requires API key for authorization.

API key can be generated in Woodpecker app.

API Key is a part of an API Key and Integrations add-on, click here to learn how to get it on Marketplace »

Rate limits:

  • There is unlimited number of API calls per month.
  • Only 1 request can be processed at time.
  • The time limit for queued requests is 15 seconds. The maximum number of queued API requests is 6. Every request above this number will be immediately dropped.

Remember, there are currently two versions of Woodpecker API – 1.0 and 2.0. Woodpecker API 2.0 for now covers different endpoints, but remember – this version is under ongoing development. We’re constantly adding new functionalities. You can use both versions simultaneously. A detailed documentation for Woodpecker API 1.0 can be found here.

For any API related feedback feel free to drop us a line at [email protected] .

Want to integrate with us?

If you’re interested in building a native integration with Woodpecker, fill out this form and we’ll get back to you.