Open documentation ↗Overview
AppVeyor is a hosted continuous integration service which runs on Microsoft Windows. The AppVeyor REST API provides a RESTful way to interact with the AppVeyor service. This includes managing projects, builds, deployments, and the teams that build them. Additional help and discussion of the AppVeyor REST API is available at http://help.appveyor.com/discussions This Swagger definition is an **unofficial** description of the AppVeyor REST API maintained at https://github.com/kevinoid/appveyor-swagger Please report any issues or suggestions for this Swagger definition at https://github.com/kevinoid/appveyor-swagger/issues/new #### API Conventions Fields which are missing from update operations (`PUT` requests) are typically reset to their default values. So although most fields are not technically required, they should usually be specified in practice.
AppVeyor REST API is a development API from appveyor.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 53 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Development
- Base URL
https://ci.appveyor.com/api- Version
- 1.0.0
- Endpoints
- 53
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://ci.appveyor.com/api/collaborators" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch("https://ci.appveyor.com/api/collaborators", {
method: "GET",
headers: {
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://ci.appveyor.com/api/collaborators",
headers={
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /account/encrypt | Encrypt a value for use in StoredValue. |
| GET | /buildjobs/{jobId}/artifacts | Get build artifacts |
| GET | /buildjobs/{jobId}/artifacts/{artifactFileName} | Download build artifact |
| GET | /buildjobs/{jobId}/log | Download build log |
| POST | /builds | Start build of branch most recent commit |
| PUT | /builds | Re-run build |
| DELETE | /builds/{accountName}/{projectSlug}/{buildVersion} | Cancel build |
| GET | /collaborators | Get collaborators |
| PUT | /collaborators | Update collaborator |
| GET | /collaborators/{userId} | Get collaborator |
| DELETE | /collaborators/{userId} | Delete collaborator |
| POST | /deployments | Start deployment |
| PUT | /deployments/stop | Cancel deployment |
| GET | /deployments/{deploymentId} | Get deployment |
| GET | /environments | Get environments |
| POST | /environments | Add environment |
| PUT | /environments | Update environment |
| DELETE | /environments/{deploymentEnvironmentId} | Delete environment |
| GET | /environments/{deploymentEnvironmentId}/deployments | Get environment deployments |
| GET | /environments/{deploymentEnvironmentId}/settings | Get environment settings |
| GET | /projects | Get projects |
| POST | /projects | Add project |
| PUT | /projects | Update project |
| GET | /projects/status/{badgeRepoProvider}/{repoAccountName}/{repoSlug} | Get status badge image for a project with a public repository |
| GET | /projects/status/{statusBadgeId} | Get project status badge image |
| GET | /projects/status/{statusBadgeId}/branch/{buildBranch} | Get project branch status badge image |
| GET | /projects/{accountName}/{projectSlug} | Get project last build |
| DELETE | /projects/{accountName}/{projectSlug} | Delete project |
| GET | /projects/{accountName}/{projectSlug}/artifacts/{artifactFileName} | Get last successful build artifact |
| GET | /projects/{accountName}/{projectSlug}/branch/{buildBranch} | Get project last branch build |
| GET | /projects/{accountName}/{projectSlug}/build/{buildVersion} | Get project build by version |
| DELETE | /projects/{accountName}/{projectSlug}/buildcache | Delete project build cache |
| GET | /projects/{accountName}/{projectSlug}/deployments | Get project deployments |
| GET | /projects/{accountName}/{projectSlug}/history | Get project history |
| GET | /projects/{accountName}/{projectSlug}/settings | Get project settings |
| PUT | /projects/{accountName}/{projectSlug}/settings/build-number | Update project build number |
| GET | /projects/{accountName}/{projectSlug}/settings/environment-variables | Get project environment variables |
| PUT | /projects/{accountName}/{projectSlug}/settings/environment-variables | Update project environment variables |
| GET | /projects/{accountName}/{projectSlug}/settings/yaml | Get project settings in YAML |
| PUT | /projects/{accountName}/{projectSlug}/settings/yaml | Update project settings in YAML |
| GET | /roles | Get roles |
| POST | /roles | Add role |
| PUT | /roles | Update role |
| GET | /roles/{roleId} | Get role |
| DELETE | /roles/{roleId} | Delete role |
| PUT | /user/join-account | Join Account |
| GET | /users | Get users |
| PUT | /users | Update user |
| GET | /users/invitations | Get user invitations |
| POST | /users/invitations | Invite user |
| DELETE | /users/invitations/{userInvitationId} | Cancel user invitation |
| GET | /users/{userId} | Get user |
| DELETE | /users/{userId} | Delete user |
Questions
Does the AppVeyor REST API API need an API key?
Yes. The AppVeyor REST API API uses API key authentication; the documentation explains how to get credentials.
Does the AppVeyor REST API API support HTTPS?
Yes, the AppVeyor REST API API is served over HTTPS.
How many endpoints does the AppVeyor REST API API have?
Its OpenAPI description lists 53 endpoints in version 1.0.0. All of them are shown on this page.
What are alternatives to the AppVeyor REST API API?
Other Development APIs include Cloudflare, Azure DevOps, IPify, App Store Connect API, StackExchange.
Similar development APIs
Compare alternatives →Cloudflare
DevelopmentManage DNS, CDN, Workers and other services; documented with an official OpenAPI 3.0 spec
Azure DevOps
DevelopmentThe Azure DevOps basic components of a REST API request/response pair
IPify
DevelopmentA simple IP Address API
App Store Connect API
DevelopmentThe data structure that represents an app store connect api resource.
StackExchange
DevelopmentQ&A forum for developers
IPinfo
DevelopmentAnother simple IP Address API
Listed from APIs.guru (CC0).