Woodpecker CI API (dev)
Download OpenAPI specification:Download
Woodpecker is a simple, yet powerful CI/CD engine with great extensibility. To get a personal access token (PAT) for authentication, please log in your Woodpecker server, and go to you personal profile page, by clicking the user icon at the top right.
List agents
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "backend": "string",
- "capacity": 0,
- "created": 0,
- "custom_labels": {
- "property1": "string",
- "property2": "string"
}, - "id": 0,
- "last_contact": 0,
- "last_work": 0,
- "name": "string",
- "no_schedule": true,
- "org_id": 0,
- "owner_id": 0,
- "platform": "string",
- "token": "string",
- "updated": 0,
- "version": "string"
}
]
Create a new agent
Creates a new agent with a random token
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the agent's data (only 'name' and 'no_schedule' are read)
backend | string |
capacity | integer |
created | integer |
object | |
id | integer |
last_contact | integer |
last_work | integer last time the agent did something, this value is used to determine if the agent is still doing work used by the autoscaler |
name | string |
no_schedule | boolean |
org_id | integer OrgID is counted as unset if set to -1, this is done to ensure a new(Agent) still enforce the OrgID check by default |
owner_id | integer |
platform | string |
token | string |
updated | integer |
version | string |
Responses
Response samples
- 200
{- "backend": "string",
- "capacity": 0,
- "created": 0,
- "custom_labels": {
- "property1": "string",
- "property2": "string"
}, - "id": 0,
- "last_contact": 0,
- "last_work": 0,
- "name": "string",
- "no_schedule": true,
- "org_id": 0,
- "owner_id": 0,
- "platform": "string",
- "token": "string",
- "updated": 0,
- "version": "string"
}
Get an agent
path Parameters
agent required | integer the agent's id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "backend": "string",
- "capacity": 0,
- "created": 0,
- "custom_labels": {
- "property1": "string",
- "property2": "string"
}, - "id": 0,
- "last_contact": 0,
- "last_work": 0,
- "name": "string",
- "no_schedule": true,
- "org_id": 0,
- "owner_id": 0,
- "platform": "string",
- "token": "string",
- "updated": 0,
- "version": "string"
}
Update an agent
path Parameters
agent required | integer the agent's id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the agent's data
backend | string |
capacity | integer |
created | integer |
object | |
id | integer |
last_contact | integer |
last_work | integer last time the agent did something, this value is used to determine if the agent is still doing work used by the autoscaler |
name | string |
no_schedule | boolean |
org_id | integer OrgID is counted as unset if set to -1, this is done to ensure a new(Agent) still enforce the OrgID check by default |
owner_id | integer |
platform | string |
token | string |
updated | integer |
version | string |
Responses
Response samples
- 200
{- "backend": "string",
- "capacity": 0,
- "created": 0,
- "custom_labels": {
- "property1": "string",
- "property2": "string"
}, - "id": 0,
- "last_contact": 0,
- "last_work": 0,
- "name": "string",
- "no_schedule": true,
- "org_id": 0,
- "owner_id": 0,
- "platform": "string",
- "token": "string",
- "updated": 0,
- "version": "string"
}
List agent tasks
path Parameters
agent required | integer the agent's id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "agent_id": 0,
- "dep_status": {
- "property1": "skipped",
- "property2": "skipped"
}, - "dependencies": [
- "string"
], - "id": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "run_on": [
- "string"
]
}
]
List agents for an organization
path Parameters
org_id required | integer the organization's id |
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "backend": "string",
- "capacity": 0,
- "created": 0,
- "custom_labels": {
- "property1": "string",
- "property2": "string"
}, - "id": 0,
- "last_contact": 0,
- "last_work": 0,
- "name": "string",
- "no_schedule": true,
- "org_id": 0,
- "owner_id": 0,
- "platform": "string",
- "token": "string",
- "updated": 0,
- "version": "string"
}
]
Create a new organization-scoped agent
Creates a new agent with a random token, scoped to the specified organization
path Parameters
org_id required | integer the organization's id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the agent's data (only 'name' and 'no_schedule' are read)
backend | string |
capacity | integer |
created | integer |
object | |
id | integer |
last_contact | integer |
last_work | integer last time the agent did something, this value is used to determine if the agent is still doing work used by the autoscaler |
name | string |
no_schedule | boolean |
org_id | integer OrgID is counted as unset if set to -1, this is done to ensure a new(Agent) still enforce the OrgID check by default |
owner_id | integer |
platform | string |
token | string |
updated | integer |
version | string |
Responses
Response samples
- 200
{- "backend": "string",
- "capacity": 0,
- "created": 0,
- "custom_labels": {
- "property1": "string",
- "property2": "string"
}, - "id": 0,
- "last_contact": 0,
- "last_work": 0,
- "name": "string",
- "no_schedule": true,
- "org_id": 0,
- "owner_id": 0,
- "platform": "string",
- "token": "string",
- "updated": 0,
- "version": "string"
}
Update an organization-scoped agent
path Parameters
org_id required | integer the organization's id |
agent_id required | integer the agent's id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the agent's updated data
backend | string |
capacity | integer |
created | integer |
object | |
id | integer |
last_contact | integer |
last_work | integer last time the agent did something, this value is used to determine if the agent is still doing work used by the autoscaler |
name | string |
no_schedule | boolean |
org_id | integer OrgID is counted as unset if set to -1, this is done to ensure a new(Agent) still enforce the OrgID check by default |
owner_id | integer |
platform | string |
token | string |
updated | integer |
version | string |
Responses
Response samples
- 200
{- "backend": "string",
- "capacity": 0,
- "created": 0,
- "custom_labels": {
- "property1": "string",
- "property2": "string"
}, - "id": 0,
- "last_contact": 0,
- "last_work": 0,
- "name": "string",
- "no_schedule": true,
- "org_id": 0,
- "owner_id": 0,
- "platform": "string",
- "token": "string",
- "updated": 0,
- "version": "string"
}
Provide pipeline status information to the CCMenu tool
CCMenu displays the pipeline status of projects on a CI server as an item in the Mac's menu bar. More details on how to install, you can find at http://ccmenu.org/ The response format adheres to CCTray v1 Specification, https://cctray.org/v1/
path Parameters
repo_id required | integer the repository id |
Responses
Get pprof stack traces of all current goroutines
Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
query Parameters
debug | integer Default: 1 Use debug=2 as a query parameter to export in the same format as an un-recovered panic |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Get pprof heap dump, a sampling of memory allocations of live objects
Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
query Parameters
gc | string Default: "" You can specify gc=heap to run GC before taking the heap sample |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Get pprof CPU profile
Only available, when server was started with WOODPECKER_LOG_LEVEL=debug After you get the profile file, use the go tool pprof command to investigate the profile.
query Parameters
seconds required | integer You can specify the duration in the seconds GET parameter. |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Get pprof program counters mapping to function names
Only available, when server was started with WOODPECKER_LOG_LEVEL=debug Looks up the program counters listed in the request, responding with a table mapping program counters to function names. The requested program counters can be provided via GET + query parameters, or POST + body parameters. Program counters shall be space delimited.
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Get pprof program counters mapping to function names
Only available, when server was started with WOODPECKER_LOG_LEVEL=debug Looks up the program counters listed in the request, responding with a table mapping program counters to function names. The requested program counters can be provided via GET + query parameters, or POST + body parameters. Program counters shall be space delimited.
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Get a trace of execution of the current program
Only available, when server was started with WOODPECKER_LOG_LEVEL=debug After you get the profile file, use the go tool pprof command to investigate the profile.
query Parameters
seconds required | integer You can specify the duration in the seconds GET parameter. |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
List forges
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "additional_options": {
- "property1": null,
- "property2": null
}, - "client": "string",
- "id": 0,
- "oauth_host": "string",
- "skip_verify": true,
- "type": "github",
- "url": "string"
}
]
Create a new forge
Creates a new forge with a random token
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the forge's data (only 'name' and 'no_schedule' are read)
object | |
client | string |
id | integer |
oauth_host | string public url for oauth if different from url |
skip_verify | boolean |
type | string (model.ForgeType) Enum: "github" "gitlab" "gitea" "forgejo" "bitbucket" "bitbucket-dc" "addon" |
url | string |
Responses
Response samples
- 200
{- "additional_options": {
- "property1": null,
- "property2": null
}, - "client": "string",
- "id": 0,
- "oauth_host": "string",
- "skip_verify": true,
- "type": "github",
- "url": "string"
}
Get a forge
path Parameters
forgeId required | integer the forge's id |
header Parameters
Authorization | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "additional_options": {
- "property1": null,
- "property2": null
}, - "client": "string",
- "id": 0,
- "oauth_host": "string",
- "skip_verify": true,
- "type": "github",
- "url": "string"
}
Update a forge
path Parameters
forgeId required | integer the forge's id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the forge's data
object | |
client | string |
id | integer |
oauth_host | string public url for oauth if different from url |
skip_verify | boolean |
type | string (model.ForgeType) Enum: "github" "gitlab" "gitea" "forgejo" "bitbucket" "bitbucket-dc" "addon" |
url | string |
Responses
Response samples
- 200
{- "additional_options": {
- "property1": null,
- "property2": null
}, - "client": "string",
- "id": 0,
- "oauth_host": "string",
- "skip_verify": true,
- "type": "github",
- "url": "string"
}
Set log level
Endpoint sets the current logging level. Requires admin rights.
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the new log level, one of <debug,trace,info,warn,error,fatal,panic,disabled>
log-level | string |
Responses
Response samples
- 200
{- "log-level": "string"
}
Lookup an organization by full name
path Parameters
org_full_name required | string the organizations full name / slug |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "forge_id": 0,
- "id": 0,
- "is_user": true,
- "name": "string"
}
List organizations
Returns all registered orgs in the system. Requires admin rights.
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "forge_id": 0,
- "id": 0,
- "is_user": true,
- "name": "string"
}
]
Get an organization
path Parameters
org_id required | string the organization's id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "forge_id": 0,
- "id": 0,
- "is_user": true,
- "name": "string"
}
]
Get the permissions of the currently authenticated user for the given organization
path Parameters
org_id required | string the organization's id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "admin": true,
- "member": true
}
]
List organization registries
path Parameters
org_id required | string the org's id |
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "address": "string",
- "id": 0,
- "org_id": 0,
- "password": "string",
- "readonly": true,
- "repo_id": 0,
- "username": "string"
}
]
Create an organization registry
path Parameters
org_id required | string the org's id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the new registry
address | string |
id | integer |
org_id | integer |
password | string |
readonly | boolean |
repo_id | integer |
username | string |
Responses
Response samples
- 200
{- "address": "string",
- "id": 0,
- "org_id": 0,
- "password": "string",
- "readonly": true,
- "repo_id": 0,
- "username": "string"
}
Get a organization registry by address
path Parameters
org_id required | string the org's id |
registry required | string the registry's address |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "address": "string",
- "id": 0,
- "org_id": 0,
- "password": "string",
- "readonly": true,
- "repo_id": 0,
- "username": "string"
}
Update an organization registry by name
path Parameters
org_id required | string the org's id |
registry required | string the registry's name |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the update registry data
address | string |
id | integer |
org_id | integer |
password | string |
readonly | boolean |
repo_id | integer |
username | string |
Responses
Response samples
- 200
{- "address": "string",
- "id": 0,
- "org_id": 0,
- "password": "string",
- "readonly": true,
- "repo_id": 0,
- "username": "string"
}
List organization secrets
path Parameters
org_id required | string the org's id |
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "events": [
- "push"
], - "id": 0,
- "images": [
- "string"
], - "name": "string",
- "org_id": 0,
- "repo_id": 0,
- "value": "string"
}
]
Create an organization secret
path Parameters
org_id required | string the org's id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the new secret
events | Array of strings (WebhookEvent) Items Enum: "push" "pull_request" "pull_request_closed" "tag" "release" "deployment" "cron" "manual" |
id | integer |
images | Array of strings |
name | string |
org_id | integer |
repo_id | integer |
value | string |
Responses
Response samples
- 200
{- "events": [
- "push"
], - "id": 0,
- "images": [
- "string"
], - "name": "string",
- "org_id": 0,
- "repo_id": 0,
- "value": "string"
}
Get a organization secret by name
path Parameters
org_id required | string the org's id |
secret required | string the secret's name |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "events": [
- "push"
], - "id": 0,
- "images": [
- "string"
], - "name": "string",
- "org_id": 0,
- "repo_id": 0,
- "value": "string"
}
Update an organization secret by name
path Parameters
org_id required | string the org's id |
secret required | string the secret's name |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the update secret data
events | Array of strings (WebhookEvent) Items Enum: "push" "pull_request" "pull_request_closed" "tag" "release" "deployment" "cron" "manual" |
id | integer |
images | Array of strings |
name | string |
org_id | integer |
repo_id | integer |
value | string |
Responses
Response samples
- 200
{- "events": [
- "push"
], - "id": 0,
- "images": [
- "string"
], - "name": "string",
- "org_id": 0,
- "repo_id": 0,
- "value": "string"
}
List pipelines in queue
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "author": "string",
- "author_avatar": "string",
- "author_email": "string",
- "branch": "string",
- "commit": "string",
- "created": 0,
- "event": "string",
- "finished": 0,
- "id": 0,
- "message": "string",
- "number": 0,
- "ref": "string",
- "refspec": "string",
- "repo_id": 0,
- "started": 0,
- "status": "string",
- "title": "string"
}
]
Get pipeline queue information
TODO: link the InfoT response object - this is blocked, until the swaggo/swag
tool dependency is v1.18.12 or newer
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "property1": "string",
- "property2": "string"
}
List global registries
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "address": "string",
- "id": 0,
- "org_id": 0,
- "password": "string",
- "readonly": true,
- "repo_id": 0,
- "username": "string"
}
]
Create a global registry
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the registry object data
address | string |
id | integer |
org_id | integer |
password | string |
readonly | boolean |
repo_id | integer |
username | string |
Responses
Response samples
- 200
{- "address": "string",
- "id": 0,
- "org_id": 0,
- "password": "string",
- "readonly": true,
- "repo_id": 0,
- "username": "string"
}
Get a global registry by name
path Parameters
registry required | string the registry's name |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "address": "string",
- "id": 0,
- "org_id": 0,
- "password": "string",
- "readonly": true,
- "repo_id": 0,
- "username": "string"
}
Update a global registry by name
path Parameters
registry required | string the registry's name |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the registry's data
address | string |
id | integer |
org_id | integer |
password | string |
readonly | boolean |
repo_id | integer |
username | string |
Responses
Response samples
- 200
{- "address": "string",
- "id": 0,
- "org_id": 0,
- "password": "string",
- "readonly": true,
- "repo_id": 0,
- "username": "string"
}
List all repositories on the server
Returns a list of all repositories. Requires admin rights.
query Parameters
active | boolean only list active repos |
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "active": true,
- "allow_deploy": true,
- "allow_pr": true,
- "avatar_url": "string",
- "cancel_previous_pipeline_events": [
- "push"
], - "clone_url": "string",
- "clone_url_ssh": "string",
- "config_file": "string",
- "default_branch": "string",
- "forge_id": 0,
- "forge_remote_id": "string",
- "forge_url": "string",
- "full_name": "string",
- "gated": true,
- "id": 0,
- "name": "string",
- "netrc_only_trusted": true,
- "org_id": 0,
- "owner": "string",
- "pr_enabled": true,
- "private": true,
- "scm": "git",
- "timeout": 0,
- "trusted": true,
- "visibility": "public"
}
]
Activate a repository
query Parameters
forge_remote_id required | string the id of a repository at the forge |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "active": true,
- "allow_deploy": true,
- "allow_pr": true,
- "avatar_url": "string",
- "cancel_previous_pipeline_events": [
- "push"
], - "clone_url": "string",
- "clone_url_ssh": "string",
- "config_file": "string",
- "default_branch": "string",
- "forge_id": 0,
- "forge_remote_id": "string",
- "forge_url": "string",
- "full_name": "string",
- "gated": true,
- "id": 0,
- "name": "string",
- "netrc_only_trusted": true,
- "org_id": 0,
- "owner": "string",
- "pr_enabled": true,
- "private": true,
- "scm": "git",
- "timeout": 0,
- "trusted": true,
- "visibility": "public"
}
Lookup a repository by full name
path Parameters
repo_full_name required | string the repository full name / slug |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "active": true,
- "allow_deploy": true,
- "allow_pr": true,
- "avatar_url": "string",
- "cancel_previous_pipeline_events": [
- "push"
], - "clone_url": "string",
- "clone_url_ssh": "string",
- "config_file": "string",
- "default_branch": "string",
- "forge_id": 0,
- "forge_remote_id": "string",
- "forge_url": "string",
- "full_name": "string",
- "gated": true,
- "id": 0,
- "name": "string",
- "netrc_only_trusted": true,
- "org_id": 0,
- "owner": "string",
- "pr_enabled": true,
- "private": true,
- "scm": "git",
- "timeout": 0,
- "trusted": true,
- "visibility": "public"
}
Delete a repository
path Parameters
repo_id required | integer the repository id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "active": true,
- "allow_deploy": true,
- "allow_pr": true,
- "avatar_url": "string",
- "cancel_previous_pipeline_events": [
- "push"
], - "clone_url": "string",
- "clone_url_ssh": "string",
- "config_file": "string",
- "default_branch": "string",
- "forge_id": 0,
- "forge_remote_id": "string",
- "forge_url": "string",
- "full_name": "string",
- "gated": true,
- "id": 0,
- "name": "string",
- "netrc_only_trusted": true,
- "org_id": 0,
- "owner": "string",
- "pr_enabled": true,
- "private": true,
- "scm": "git",
- "timeout": 0,
- "trusted": true,
- "visibility": "public"
}
Get a repository
path Parameters
repo_id required | integer the repository id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "active": true,
- "allow_deploy": true,
- "allow_pr": true,
- "avatar_url": "string",
- "cancel_previous_pipeline_events": [
- "push"
], - "clone_url": "string",
- "clone_url_ssh": "string",
- "config_file": "string",
- "default_branch": "string",
- "forge_id": 0,
- "forge_remote_id": "string",
- "forge_url": "string",
- "full_name": "string",
- "gated": true,
- "id": 0,
- "name": "string",
- "netrc_only_trusted": true,
- "org_id": 0,
- "owner": "string",
- "pr_enabled": true,
- "private": true,
- "scm": "git",
- "timeout": 0,
- "trusted": true,
- "visibility": "public"
}
Update a repository
path Parameters
repo_id required | integer the repository id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the repository's information
allow_deploy | boolean |
allow_pr | boolean |
cancel_previous_pipeline_events | Array of strings (WebhookEvent) Items Enum: "push" "pull_request" "pull_request_closed" "tag" "release" "deployment" "cron" "manual" |
config_file | string |
gated | boolean |
netrc_only_trusted | boolean |
timeout | integer |
trusted | boolean |
visibility | string |
Responses
Response samples
- 200
{- "active": true,
- "allow_deploy": true,
- "allow_pr": true,
- "avatar_url": "string",
- "cancel_previous_pipeline_events": [
- "push"
], - "clone_url": "string",
- "clone_url_ssh": "string",
- "config_file": "string",
- "default_branch": "string",
- "forge_id": 0,
- "forge_remote_id": "string",
- "forge_url": "string",
- "full_name": "string",
- "gated": true,
- "id": 0,
- "name": "string",
- "netrc_only_trusted": true,
- "org_id": 0,
- "owner": "string",
- "pr_enabled": true,
- "private": true,
- "scm": "git",
- "timeout": 0,
- "trusted": true,
- "visibility": "public"
}
Get branches of a repository
path Parameters
repo_id required | integer the repository id |
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- "string"
]
Change a repository's owner to the currently authenticated user
path Parameters
repo_id required | integer the repository id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "active": true,
- "allow_deploy": true,
- "allow_pr": true,
- "avatar_url": "string",
- "cancel_previous_pipeline_events": [
- "push"
], - "clone_url": "string",
- "clone_url_ssh": "string",
- "config_file": "string",
- "default_branch": "string",
- "forge_id": 0,
- "forge_remote_id": "string",
- "forge_url": "string",
- "full_name": "string",
- "gated": true,
- "id": 0,
- "name": "string",
- "netrc_only_trusted": true,
- "org_id": 0,
- "owner": "string",
- "pr_enabled": true,
- "private": true,
- "scm": "git",
- "timeout": 0,
- "trusted": true,
- "visibility": "public"
}
Check current authenticated users access to the repository
The repository permission, according to the used access token.
path Parameters
repo_id required | integer the repository id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "admin": true,
- "created": 0,
- "pull": true,
- "push": true,
- "synced": 0,
- "updated": 0
}
List active pull requests of a repository
path Parameters
repo_id required | integer the repository id |
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "index": "string",
- "title": "string"
}
]
List cron jobs
path Parameters
repo_id required | integer the repository id |
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "branch": "string",
- "created": 0,
- "creator_id": 0,
- "id": 0,
- "name": "string",
- "next_exec": 0,
- "repo_id": 0,
- "schedule": "string"
}
]
Create a cron job
path Parameters
repo_id required | integer the repository id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the new cron job
branch | string |
created | integer |
creator_id | integer |
id | integer |
name | string |
next_exec | integer |
repo_id | integer |
schedule | string @weekly, 3min, ... |
Responses
Response samples
- 200
{- "branch": "string",
- "created": 0,
- "creator_id": 0,
- "id": 0,
- "name": "string",
- "next_exec": 0,
- "repo_id": 0,
- "schedule": "string"
}
Get a cron job
path Parameters
repo_id required | integer the repository id |
cron required | string the cron job id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "branch": "string",
- "created": 0,
- "creator_id": 0,
- "id": 0,
- "name": "string",
- "next_exec": 0,
- "repo_id": 0,
- "schedule": "string"
}
Update a cron job
path Parameters
repo_id required | integer the repository id |
cron required | string the cron job id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the cron job data
branch | string |
created | integer |
creator_id | integer |
id | integer |
name | string |
next_exec | integer |
repo_id | integer |
schedule | string @weekly, 3min, ... |
Responses
Response samples
- 200
{- "branch": "string",
- "created": 0,
- "creator_id": 0,
- "id": 0,
- "name": "string",
- "next_exec": 0,
- "repo_id": 0,
- "schedule": "string"
}
Start a cron job now
path Parameters
repo_id required | integer the repository id |
cron required | string the cron job id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "author": "string",
- "author_avatar": "string",
- "author_email": "string",
- "branch": "string",
- "changed_files": [
- "string"
], - "commit": "string",
- "created": 0,
- "deploy_task": "string",
- "deploy_to": "string",
- "errors": [
- {
- "data": null,
- "is_warning": true,
- "message": "string",
- "type": "linter"
}
], - "event": "push",
- "finished": 0,
- "forge_url": "string",
- "id": 0,
- "is_prerelease": true,
- "message": "string",
- "number": 0,
- "parent": 0,
- "pr_labels": [
- "string"
], - "ref": "string",
- "refspec": "string",
- "reviewed": 0,
- "reviewed_by": "string",
- "sender": "string",
- "started": 0,
- "status": "skipped",
- "timestamp": 0,
- "title": "string",
- "updated": 0,
- "variables": {
- "property1": "string",
- "property2": "string"
}, - "workflows": [
- {
- "agent_id": 0,
- "children": [
- {
- "error": "string",
- "exit_code": 0,
- "finished": 0,
- "id": 0,
- "name": "string",
- "pid": 0,
- "pipeline_id": 0,
- "ppid": 0,
- "started": 0,
- "state": "skipped",
- "type": "clone",
- "uuid": "string"
}
], - "environ": {
- "property1": "string",
- "property2": "string"
}, - "error": "string",
- "finished": 0,
- "id": 0,
- "name": "string",
- "pid": 0,
- "pipeline_id": 0,
- "platform": "string",
- "started": 0,
- "state": "skipped"
}
]
}
Get logs for a pipeline step
path Parameters
repo_id required | integer the repository id |
number required | integer the number of the pipeline |
stepID required | integer the step id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "data": [
- 0
], - "id": 0,
- "line": 0,
- "step_id": 0,
- "time": 0,
- "type": 0
}
]
List repository pipelines
Get a list of pipelines for a repository.
path Parameters
repo_id required | integer the repository id |
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
before | string only return pipelines before this RFC3339 date |
after | string only return pipelines after this RFC3339 date |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "author": "string",
- "author_avatar": "string",
- "author_email": "string",
- "branch": "string",
- "changed_files": [
- "string"
], - "commit": "string",
- "created": 0,
- "deploy_task": "string",
- "deploy_to": "string",
- "errors": [
- {
- "data": null,
- "is_warning": true,
- "message": "string",
- "type": "linter"
}
], - "event": "push",
- "finished": 0,
- "forge_url": "string",
- "id": 0,
- "is_prerelease": true,
- "message": "string",
- "number": 0,
- "parent": 0,
- "pr_labels": [
- "string"
], - "ref": "string",
- "refspec": "string",
- "reviewed": 0,
- "reviewed_by": "string",
- "sender": "string",
- "started": 0,
- "status": "skipped",
- "timestamp": 0,
- "title": "string",
- "updated": 0,
- "variables": {
- "property1": "string",
- "property2": "string"
}, - "workflows": [
- {
- "agent_id": 0,
- "children": [
- {
- "error": "string",
- "exit_code": 0,
- "finished": 0,
- "id": 0,
- "name": "string",
- "pid": 0,
- "pipeline_id": 0,
- "ppid": 0,
- "started": 0,
- "state": "skipped",
- "type": "clone",
- "uuid": "string"
}
], - "environ": {
- "property1": "string",
- "property2": "string"
}, - "error": "string",
- "finished": 0,
- "id": 0,
- "name": "string",
- "pid": 0,
- "pipeline_id": 0,
- "platform": "string",
- "started": 0,
- "state": "skipped"
}
]
}
]
Trigger a manual pipeline
path Parameters
repo_id required | integer the repository id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the options for the pipeline to run
branch | string |
object |
Responses
Response samples
- 200
{- "author": "string",
- "author_avatar": "string",
- "author_email": "string",
- "branch": "string",
- "changed_files": [
- "string"
], - "commit": "string",
- "created": 0,
- "deploy_task": "string",
- "deploy_to": "string",
- "errors": [
- {
- "data": null,
- "is_warning": true,
- "message": "string",
- "type": "linter"
}
], - "event": "push",
- "finished": 0,
- "forge_url": "string",
- "id": 0,
- "is_prerelease": true,
- "message": "string",
- "number": 0,
- "parent": 0,
- "pr_labels": [
- "string"
], - "ref": "string",
- "refspec": "string",
- "reviewed": 0,
- "reviewed_by": "string",
- "sender": "string",
- "started": 0,
- "status": "skipped",
- "timestamp": 0,
- "title": "string",
- "updated": 0,
- "variables": {
- "property1": "string",
- "property2": "string"
}, - "workflows": [
- {
- "agent_id": 0,
- "children": [
- {
- "error": "string",
- "exit_code": 0,
- "finished": 0,
- "id": 0,
- "name": "string",
- "pid": 0,
- "pipeline_id": 0,
- "ppid": 0,
- "started": 0,
- "state": "skipped",
- "type": "clone",
- "uuid": "string"
}
], - "environ": {
- "property1": "string",
- "property2": "string"
}, - "error": "string",
- "finished": 0,
- "id": 0,
- "name": "string",
- "pid": 0,
- "pipeline_id": 0,
- "platform": "string",
- "started": 0,
- "state": "skipped"
}
]
}
Get a repositories pipeline
path Parameters
repo_id required | integer the repository id |
number required | integer the number of the pipeline, OR 'latest' |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "author": "string",
- "author_avatar": "string",
- "author_email": "string",
- "branch": "string",
- "changed_files": [
- "string"
], - "commit": "string",
- "created": 0,
- "deploy_task": "string",
- "deploy_to": "string",
- "errors": [
- {
- "data": null,
- "is_warning": true,
- "message": "string",
- "type": "linter"
}
], - "event": "push",
- "finished": 0,
- "forge_url": "string",
- "id": 0,
- "is_prerelease": true,
- "message": "string",
- "number": 0,
- "parent": 0,
- "pr_labels": [
- "string"
], - "ref": "string",
- "refspec": "string",
- "reviewed": 0,
- "reviewed_by": "string",
- "sender": "string",
- "started": 0,
- "status": "skipped",
- "timestamp": 0,
- "title": "string",
- "updated": 0,
- "variables": {
- "property1": "string",
- "property2": "string"
}, - "workflows": [
- {
- "agent_id": 0,
- "children": [
- {
- "error": "string",
- "exit_code": 0,
- "finished": 0,
- "id": 0,
- "name": "string",
- "pid": 0,
- "pipeline_id": 0,
- "ppid": 0,
- "started": 0,
- "state": "skipped",
- "type": "clone",
- "uuid": "string"
}
], - "environ": {
- "property1": "string",
- "property2": "string"
}, - "error": "string",
- "finished": 0,
- "id": 0,
- "name": "string",
- "pid": 0,
- "pipeline_id": 0,
- "platform": "string",
- "started": 0,
- "state": "skipped"
}
]
}
Restart a pipeline
Restarts a pipeline optional with altered event, deploy or environment
path Parameters
repo_id required | integer the repository id |
number required | integer the number of the pipeline |
query Parameters
event | string override the event type |
deploy_to | string override the target deploy value |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "author": "string",
- "author_avatar": "string",
- "author_email": "string",
- "branch": "string",
- "changed_files": [
- "string"
], - "commit": "string",
- "created": 0,
- "deploy_task": "string",
- "deploy_to": "string",
- "errors": [
- {
- "data": null,
- "is_warning": true,
- "message": "string",
- "type": "linter"
}
], - "event": "push",
- "finished": 0,
- "forge_url": "string",
- "id": 0,
- "is_prerelease": true,
- "message": "string",
- "number": 0,
- "parent": 0,
- "pr_labels": [
- "string"
], - "ref": "string",
- "refspec": "string",
- "reviewed": 0,
- "reviewed_by": "string",
- "sender": "string",
- "started": 0,
- "status": "skipped",
- "timestamp": 0,
- "title": "string",
- "updated": 0,
- "variables": {
- "property1": "string",
- "property2": "string"
}, - "workflows": [
- {
- "agent_id": 0,
- "children": [
- {
- "error": "string",
- "exit_code": 0,
- "finished": 0,
- "id": 0,
- "name": "string",
- "pid": 0,
- "pipeline_id": 0,
- "ppid": 0,
- "started": 0,
- "state": "skipped",
- "type": "clone",
- "uuid": "string"
}
], - "environ": {
- "property1": "string",
- "property2": "string"
}, - "error": "string",
- "finished": 0,
- "id": 0,
- "name": "string",
- "pid": 0,
- "pipeline_id": 0,
- "platform": "string",
- "started": 0,
- "state": "skipped"
}
]
}
Approve and start a pipeline
path Parameters
repo_id required | integer the repository id |
number required | integer the number of the pipeline |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "author": "string",
- "author_avatar": "string",
- "author_email": "string",
- "branch": "string",
- "changed_files": [
- "string"
], - "commit": "string",
- "created": 0,
- "deploy_task": "string",
- "deploy_to": "string",
- "errors": [
- {
- "data": null,
- "is_warning": true,
- "message": "string",
- "type": "linter"
}
], - "event": "push",
- "finished": 0,
- "forge_url": "string",
- "id": 0,
- "is_prerelease": true,
- "message": "string",
- "number": 0,
- "parent": 0,
- "pr_labels": [
- "string"
], - "ref": "string",
- "refspec": "string",
- "reviewed": 0,
- "reviewed_by": "string",
- "sender": "string",
- "started": 0,
- "status": "skipped",
- "timestamp": 0,
- "title": "string",
- "updated": 0,
- "variables": {
- "property1": "string",
- "property2": "string"
}, - "workflows": [
- {
- "agent_id": 0,
- "children": [
- {
- "error": "string",
- "exit_code": 0,
- "finished": 0,
- "id": 0,
- "name": "string",
- "pid": 0,
- "pipeline_id": 0,
- "ppid": 0,
- "started": 0,
- "state": "skipped",
- "type": "clone",
- "uuid": "string"
}
], - "environ": {
- "property1": "string",
- "property2": "string"
}, - "error": "string",
- "finished": 0,
- "id": 0,
- "name": "string",
- "pid": 0,
- "pipeline_id": 0,
- "platform": "string",
- "started": 0,
- "state": "skipped"
}
]
}
Get configuration files for a pipeline
path Parameters
repo_id required | integer the repository id |
number required | integer the number of the pipeline |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "data": [
- 0
], - "hash": "string",
- "name": "string"
}
]
Decline a pipeline
path Parameters
repo_id required | integer the repository id |
number required | integer the number of the pipeline |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "author": "string",
- "author_avatar": "string",
- "author_email": "string",
- "branch": "string",
- "changed_files": [
- "string"
], - "commit": "string",
- "created": 0,
- "deploy_task": "string",
- "deploy_to": "string",
- "errors": [
- {
- "data": null,
- "is_warning": true,
- "message": "string",
- "type": "linter"
}
], - "event": "push",
- "finished": 0,
- "forge_url": "string",
- "id": 0,
- "is_prerelease": true,
- "message": "string",
- "number": 0,
- "parent": 0,
- "pr_labels": [
- "string"
], - "ref": "string",
- "refspec": "string",
- "reviewed": 0,
- "reviewed_by": "string",
- "sender": "string",
- "started": 0,
- "status": "skipped",
- "timestamp": 0,
- "title": "string",
- "updated": 0,
- "variables": {
- "property1": "string",
- "property2": "string"
}, - "workflows": [
- {
- "agent_id": 0,
- "children": [
- {
- "error": "string",
- "exit_code": 0,
- "finished": 0,
- "id": 0,
- "name": "string",
- "pid": 0,
- "pipeline_id": 0,
- "ppid": 0,
- "started": 0,
- "state": "skipped",
- "type": "clone",
- "uuid": "string"
}
], - "environ": {
- "property1": "string",
- "property2": "string"
}, - "error": "string",
- "finished": 0,
- "id": 0,
- "name": "string",
- "pid": 0,
- "pipeline_id": 0,
- "platform": "string",
- "started": 0,
- "state": "skipped"
}
]
}
Get metadata for a pipeline or a specific workflow, including previous pipeline info
path Parameters
repo_id required | integer the repository id |
number required | integer the number of the pipeline |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "curr": {
- "commit": {
- "author": {
- "avatar": "string",
- "email": "string",
- "name": "string"
}, - "branch": "string",
- "changed_files": [
- "string"
], - "is_prerelease": true,
- "labels": [
- "string"
], - "message": "string",
- "ref": "string",
- "refspec": "string",
- "sha": "string"
}, - "created": 0,
- "cron": "string",
- "event": "string",
- "finished": 0,
- "forge_url": "string",
- "number": 0,
- "parent": 0,
- "started": 0,
- "status": "string",
- "target": "string",
- "task": "string"
}, - "forge": {
- "type": "string",
- "url": "string"
}, - "id": "string",
- "prev": {
- "commit": {
- "author": {
- "avatar": "string",
- "email": "string",
- "name": "string"
}, - "branch": "string",
- "changed_files": [
- "string"
], - "is_prerelease": true,
- "labels": [
- "string"
], - "message": "string",
- "ref": "string",
- "refspec": "string",
- "sha": "string"
}, - "created": 0,
- "cron": "string",
- "event": "string",
- "finished": 0,
- "forge_url": "string",
- "number": 0,
- "parent": 0,
- "started": 0,
- "status": "string",
- "target": "string",
- "task": "string"
}, - "repo": {
- "clone_url": "string",
- "clone_url_ssh": "string",
- "default_branch": "string",
- "forge_url": "string",
- "id": 0,
- "name": "string",
- "owner": "string",
- "private": true,
- "remote_id": "string",
- "scm": "string",
- "trusted": true
}, - "step": {
- "name": "string",
- "number": 0
}, - "sys": {
- "arch": "string",
- "host": "string",
- "name": "string",
- "url": "string",
- "version": "string"
}, - "workflow": {
- "matrix": {
- "property1": "string",
- "property2": "string"
}, - "name": "string",
- "number": 0
}
}
List registries
path Parameters
repo_id required | integer the repository id |
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "address": "string",
- "id": 0,
- "org_id": 0,
- "password": "string",
- "readonly": true,
- "repo_id": 0,
- "username": "string"
}
]
Create a registry
path Parameters
repo_id required | integer the repository id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the new registry data
address | string |
id | integer |
org_id | integer |
password | string |
readonly | boolean |
repo_id | integer |
username | string |
Responses
Response samples
- 200
{- "address": "string",
- "id": 0,
- "org_id": 0,
- "password": "string",
- "readonly": true,
- "repo_id": 0,
- "username": "string"
}
Get a registry by name
path Parameters
repo_id required | integer the repository id |
registry required | string the registry name |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "address": "string",
- "id": 0,
- "org_id": 0,
- "password": "string",
- "readonly": true,
- "repo_id": 0,
- "username": "string"
}
Update a registry by name
path Parameters
repo_id required | integer the repository id |
registry required | string the registry name |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the attributes for the registry
address | string |
id | integer |
org_id | integer |
password | string |
readonly | boolean |
repo_id | integer |
username | string |
Responses
Response samples
- 200
{- "address": "string",
- "id": 0,
- "org_id": 0,
- "password": "string",
- "readonly": true,
- "repo_id": 0,
- "username": "string"
}
List repository secrets
path Parameters
repo_id required | integer the repository id |
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "events": [
- "push"
], - "id": 0,
- "images": [
- "string"
], - "name": "string",
- "org_id": 0,
- "repo_id": 0,
- "value": "string"
}
]
Create a repository secret
path Parameters
repo_id required | integer the repository id |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the new secret
events | Array of strings (WebhookEvent) Items Enum: "push" "pull_request" "pull_request_closed" "tag" "release" "deployment" "cron" "manual" |
id | integer |
images | Array of strings |
name | string |
org_id | integer |
repo_id | integer |
value | string |
Responses
Response samples
- 200
{- "events": [
- "push"
], - "id": 0,
- "images": [
- "string"
], - "name": "string",
- "org_id": 0,
- "repo_id": 0,
- "value": "string"
}
Get a repository secret by name
path Parameters
repo_id required | integer the repository id |
secretName required | string the secret name |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "events": [
- "push"
], - "id": 0,
- "images": [
- "string"
], - "name": "string",
- "org_id": 0,
- "repo_id": 0,
- "value": "string"
}
Update a repository secret by name
path Parameters
repo_id required | integer the repository id |
secretName required | string the secret name |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the secret itself
events | Array of strings (WebhookEvent) Items Enum: "push" "pull_request" "pull_request_closed" "tag" "release" "deployment" "cron" "manual" |
id | integer |
images | Array of strings |
name | string |
org_id | integer |
repo_id | integer |
value | string |
Responses
Response samples
- 200
{- "events": [
- "push"
], - "id": 0,
- "images": [
- "string"
], - "name": "string",
- "org_id": 0,
- "repo_id": 0,
- "value": "string"
}
List global secrets
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "events": [
- "push"
], - "id": 0,
- "images": [
- "string"
], - "name": "string",
- "org_id": 0,
- "repo_id": 0,
- "value": "string"
}
]
Create a global secret
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the secret object data
events | Array of strings (WebhookEvent) Items Enum: "push" "pull_request" "pull_request_closed" "tag" "release" "deployment" "cron" "manual" |
id | integer |
images | Array of strings |
name | string |
org_id | integer |
repo_id | integer |
value | string |
Responses
Response samples
- 200
{- "events": [
- "push"
], - "id": 0,
- "images": [
- "string"
], - "name": "string",
- "org_id": 0,
- "repo_id": 0,
- "value": "string"
}
Get a global secret by name
path Parameters
secret required | string the secret's name |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "events": [
- "push"
], - "id": 0,
- "images": [
- "string"
], - "name": "string",
- "org_id": 0,
- "repo_id": 0,
- "value": "string"
}
Update a global secret by name
path Parameters
secret required | string the secret's name |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the secret's data
events | Array of strings (WebhookEvent) Items Enum: "push" "pull_request" "pull_request_closed" "tag" "release" "deployment" "cron" "manual" |
id | integer |
images | Array of strings |
name | string |
org_id | integer |
repo_id | integer |
value | string |
Responses
Response samples
- 200
{- "events": [
- "push"
], - "id": 0,
- "images": [
- "string"
], - "name": "string",
- "org_id": 0,
- "repo_id": 0,
- "value": "string"
}
Get the currently authenticated user
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "admin": true,
- "avatar_url": "string",
- "email": "string",
- "forge_id": 0,
- "id": 0,
- "login": "string",
- "org_id": 0
}
Get the currently authenticated users pipeline feed
The feed lists the most recent pipeline for the currently authenticated user.
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "author": "string",
- "author_avatar": "string",
- "author_email": "string",
- "branch": "string",
- "commit": "string",
- "created": 0,
- "event": "string",
- "finished": 0,
- "id": 0,
- "message": "string",
- "number": 0,
- "ref": "string",
- "refspec": "string",
- "repo_id": 0,
- "started": 0,
- "status": "string",
- "title": "string"
}
]
Get user's repositories
Retrieve the currently authenticated User's Repository list
query Parameters
all | boolean query all repos, including inactive ones |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "active": true,
- "allow_deploy": true,
- "allow_pr": true,
- "avatar_url": "string",
- "cancel_previous_pipeline_events": [
- "push"
], - "clone_url": "string",
- "clone_url_ssh": "string",
- "config_file": "string",
- "default_branch": "string",
- "forge_id": 0,
- "forge_remote_id": "string",
- "forge_url": "string",
- "full_name": "string",
- "gated": true,
- "id": 0,
- "name": "string",
- "netrc_only_trusted": true,
- "org_id": 0,
- "owner": "string",
- "pr_enabled": true,
- "private": true,
- "scm": "git",
- "timeout": 0,
- "trusted": true,
- "visibility": "public"
}
]
List users
Returns all registered, active users in the system. Requires admin rights.
query Parameters
page | integer Default: 1 for response pagination, page offset number |
perPage | integer Default: 50 for response pagination, max items per page |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
[- {
- "admin": true,
- "avatar_url": "string",
- "email": "string",
- "forge_id": 0,
- "id": 0,
- "login": "string",
- "org_id": 0
}
]
Create a user
Creates a new user account with the specified external login. Requires admin rights.
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: */*required
the user's data
admin | boolean Admin indicates the user is a system administrator. NOTE: If the username is part of the WOODPECKER_ADMIN environment variable, this value will be set to true on login. |
avatar_url | string the avatar url for this user. |
string Email is the email address for this user. required: true | |
forge_id | integer |
id | integer the id for this user. required: true |
login | string Login is the username for this user. required: true |
org_id | integer OrgID is the of the user as model.Org. |
Responses
Response samples
- 200
{- "admin": true,
- "avatar_url": "string",
- "email": "string",
- "forge_id": 0,
- "id": 0,
- "login": "string",
- "org_id": 0
}
Get a user
Returns a user with the specified login name. Requires admin rights.
path Parameters
login required | string the user's login name |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Responses
Response samples
- 200
{- "admin": true,
- "avatar_url": "string",
- "email": "string",
- "forge_id": 0,
- "id": 0,
- "login": "string",
- "org_id": 0
}
Update a user
Changes the data of an existing user. Requires admin rights.
path Parameters
login required | string the user's login name |
header Parameters
Authorization required | string Default: Bearer <personal access token> Insert your personal access token |
Request Body schema: application/jsonrequired
the user's data
admin | boolean Admin indicates the user is a system administrator. NOTE: If the username is part of the WOODPECKER_ADMIN environment variable, this value will be set to true on login. |
avatar_url | string the avatar url for this user. |
string Email is the email address for this user. required: true | |
forge_id | integer |
id | integer the id for this user. required: true |
login | string Login is the username for this user. required: true |
org_id | integer OrgID is the of the user as model.Org. |
Responses
Request samples
- Payload
{- "admin": true,
- "avatar_url": "string",
- "email": "string",
- "forge_id": 0,
- "id": 0,
- "login": "string",
- "org_id": 0
}
Response samples
- 200
{- "admin": true,
- "avatar_url": "string",
- "email": "string",
- "forge_id": 0,
- "id": 0,
- "login": "string",
- "org_id": 0
}