AppVeyor REST API
The AppVeyor REST API gives programmatic access to the hosted Windows‑based CI service, allowing you to create, read, update, and delete projects, builds, deployments, environments, and related resources such as artifacts, logs, collaborators, roles, and user invitations, as well as utilities like encrypting stored values.
Latency
853ms p95
Uptime
100.0% 30d
Playground
Verified
live
Endpoints
/projects/{accountName}/{projectSlug}/settings/build-number
Update project build number
/projects/{accountName}/{projectSlug}/settings/environment-variables
Get project environment variables
/account/encrypt
Encrypt a value for use in StoredValue.
/buildjobs/{jobId}/artifacts
Get build artifacts
/buildjobs/{jobId}/artifacts/{artifactFileName}
Download build artifact
/buildjobs/{jobId}/log
Download build log
/builds
Start build of branch most recent commit
/builds
Re-run build
/builds/{accountName}/{projectSlug}/{buildVersion}
Cancel build
/collaborators
Get collaborators
/collaborators
Update collaborator
/collaborators/{userId}
Delete collaborator
/collaborators/{userId}
Get collaborator
/deployments
Start deployment
/deployments/stop
Cancel deployment
/deployments/{deploymentId}
Get deployment
/environments
Get environments
/environments
Add environment
/environments
Update environment
/environments/{deploymentEnvironmentId}
Delete environment
/environments/{deploymentEnvironmentId}/deployments
Get environment deployments
/environments/{deploymentEnvironmentId}/settings
Get environment settings
/projects/{accountName}/{projectSlug}/settings/environment-variables
Update project environment variables
/projects
Get projects
/projects
Add project
/projects
Update project
/projects/status/{badgeRepoProvider}/{repoAccountName}/{repoSlug}
Get status badge image for a project with a public repository
/projects/status/{statusBadgeId}
Get project status badge image
/projects/status/{statusBadgeId}/branch/{buildBranch}
Get project branch status badge image
/projects/{accountName}/{projectSlug}
Delete project
/projects/{accountName}/{projectSlug}
Get project last build
/projects/{accountName}/{projectSlug}/artifacts/{artifactFileName}
Get last successful build artifact
/projects/{accountName}/{projectSlug}/settings/yaml
Get project settings in YAML
/projects/{accountName}/{projectSlug}/settings/yaml
Update project settings in YAML
/projects/{accountName}/{projectSlug}/branch/{buildBranch}
Get project last branch build
/projects/{accountName}/{projectSlug}/build/{buildVersion}
Get project build by version
/projects/{accountName}/{projectSlug}/buildcache
Delete project build cache
/projects/{accountName}/{projectSlug}/deployments
Get project deployments
/projects/{accountName}/{projectSlug}/history
Get project history
/projects/{accountName}/{projectSlug}/settings
Get project settings
/roles
Get roles
/roles
Add role
/roles
Update role
/roles/{roleId}
Delete role
/roles/{roleId}
Get role
/user/join-account
Join Account
/users
Get users
/users
Update user
/users/invitations
Get user invitations
/users/invitations
Invite user
/users/invitations/{userInvitationId}
Cancel user invitation
/users/{userId}
Delete user
/users/{userId}
Get user
53 endpoints auto-detected
Authentication
This API uses an API key, passed in the "Authorization" header. No OAuth required.
curl -X PUT \
"https://ci.appveyor.com/api/projects/{accountName}/{projectSlug}/settings/build-number" \
-H "Authorization: YOUR_API_KEY"ci.appveyor.com · HTTPS only