Authentication

All requests must be authenticated using an API key in the x-api-key header.

Generating an API key

To authenticate requests, you must first generate an API key. Click here to go to the API keys view, or follow the instructions below:

Log into the Woodpecker account
Go to the Marketplace in the top-right corner → Integrations → 'API keys'
Click Create a key
You can add a label to each created key to describe what integration it is being used for

API keys are user-specific, meaning each user only sees their own keys. Keep them private and do not share them with others.

The base URL is:

https://api.woodpecker.co/rest

All requests need to be authenticated using an x-api-key header. Try the request below, making sure to replace YOUR_API_KEY with your actual key.

curl --request GET \
  --url "https://api.woodpecker.co/rest/v1/me" \
  --header "x-api-key: {YOUR_API_KEY}"