Appveyor REST API

AppVeyor REST API

API version: 1.0.0

Auth

ApiKey Authorization in header

Base URL

https://ci.appveyor.com/api

Setup

1. Set your API key in the appropriate header
2. GET /users -- verify access
3. POST /users/invitations -- create first invitations

Endpoints

53 endpoints across 10 groups. See references/api-spec.lap for full details.

users

user

collaborators

roles

account

projects

builds

buildjobs

environments

deployments

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all users?" -> GET /users
• "Get user details?" -> GET /users/{userId}
• "Delete a user?" -> DELETE /users/{userId}
• "List all invitations?" -> GET /users/invitations
• "Create a invitation?" -> POST /users/invitations
• "Delete a invitation?" -> DELETE /users/invitations/{userInvitationId}
• "List all collaborators?" -> GET /collaborators
• "Get collaborator details?" -> GET /collaborators/{userId}
• "Delete a collaborator?" -> DELETE /collaborators/{userId}
• "List all roles?" -> GET /roles
• "Create a role?" -> POST /roles
• "Get role details?" -> GET /roles/{roleId}
• "Delete a role?" -> DELETE /roles/{roleId}
• "Create a encrypt?" -> POST /account/encrypt
• "List all projects?" -> GET /projects
• "Create a project?" -> POST /projects
• "Get project details?" -> GET /projects/{accountName}/{projectSlug}
• "Delete a project?" -> DELETE /projects/{accountName}/{projectSlug}
• "Get branch details?" -> GET /projects/{accountName}/{projectSlug}/branch/{buildBranch}
• "Get build details?" -> GET /projects/{accountName}/{projectSlug}/build/{buildVersion}
• "List all history?" -> GET /projects/{accountName}/{projectSlug}/history
• "Get artifact details?" -> GET /projects/{accountName}/{projectSlug}/artifacts/{artifactFileName}
• "List all deployments?" -> GET /projects/{accountName}/{projectSlug}/deployments
• "List all settings?" -> GET /projects/{accountName}/{projectSlug}/settings
• "List all yaml?" -> GET /projects/{accountName}/{projectSlug}/settings/yaml
• "List all environment-variables?" -> GET /projects/{accountName}/{projectSlug}/settings/environment-variables
• "Get status details?" -> GET /projects/status/{statusBadgeId}
• "Get branch details?" -> GET /projects/status/{statusBadgeId}/branch/{buildBranch}
• "Get status details?" -> GET /projects/status/{badgeRepoProvider}/{repoAccountName}/{repoSlug}
• "Create a build?" -> POST /builds
• "Delete a build?" -> DELETE /builds/{accountName}/{projectSlug}/{buildVersion}
• "List all artifacts?" -> GET /buildjobs/{jobId}/artifacts
• "Get artifact details?" -> GET /buildjobs/{jobId}/artifacts/{artifactFileName}
• "List all log?" -> GET /buildjobs/{jobId}/log
• "List all environments?" -> GET /environments
• "Create a environment?" -> POST /environments
• "List all settings?" -> GET /environments/{deploymentEnvironmentId}/settings
• "List all deployments?" -> GET /environments/{deploymentEnvironmentId}/deployments
• "Delete a environment?" -> DELETE /environments/{deploymentEnvironmentId}
• "Get deployment details?" -> GET /deployments/{deploymentId}
• "Create a deployment?" -> POST /deployments
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP