AppVeyor

AppVeyor REST API

AppVeyor is a hosted continuous integration service which runs on Microsoft Windows. The AppVeyor REST API provides a RESTful way to interact with the…

Developer tools#openapi#developer-tools

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

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.

Endpoints 53

Collaborator

  • GETGet collaborators/collaborators
  • PUTUpdate collaborator/collaborators
  • GETGet collaborator/collaborators/:userId
  • DELETEDelete collaborator/collaborators/:userId

Role

  • GETGet roles/roles
  • PUTUpdate role/roles
  • POSTAdd role/roles
  • GETGet role/roles/:roleId
  • DELETEDelete role/roles/:roleId

User

  • PUTJoin Account/user/join-account
  • GETGet users/users
  • PUTUpdate user/users
  • GETGet user invitations/users/invitations
  • POSTInvite user/users/invitations
  • DELETECancel user invitation/users/invitations/:userInvitationId
  • GETGet user/users/:userId
  • DELETEDelete user/users/:userId

Build

  • GETGet build artifacts/buildjobs/:jobId/artifacts
  • GETDownload build artifact/buildjobs/:jobId/artifacts/:artifactFileName
  • GETDownload build log/buildjobs/:jobId/log
  • PUTRe-run build/buildsIf reRunIncomplete is true and all jobs in the referenced build completed successfully, a 500 Internal Server Error is returned with the message "No failed or…
  • POSTStart build of branch most recent commit/builds
  • DELETECancel build/builds/:accountName/:projectSlug/:buildVersion

Project

  • POSTEncrypt a value for use in StoredValue./account/encrypt
  • GETGet projects/projects
  • PUTUpdate project/projects
  • POSTAdd project/projects
  • GETGet status badge image for a project with a public repository/projects/status/:badgeRepoProvider/:repoAccountName/:repoSlug?branch=string&svg=false&retina=false&passingText=string&failingText=string&pendingText=string
  • GETGet project status badge image/projects/status/:statusBadgeId?svg=false&retina=false&passingText=string&failingText=string&pendingText=string
  • GETGet project branch status badge image/projects/status/:statusBadgeId/branch/:buildBranch?svg=false&retina=false&passingText=string&failingText=string&pendingText=string
  • GETGet project last build/projects/:accountName/:projectSlug
  • DELETEDelete project/projects/:accountName/:projectSlug
  • GETGet last successful build artifact/projects/:accountName/:projectSlug/artifacts/:artifactFileName?branch=string&tag=string&job=string&all=false&pr=trueThe job parameter is mandatory if the build contains multiple jobs.
  • GETGet project last branch build/projects/:accountName/:projectSlug/branch/:buildBranch
  • GETGet project build by version/projects/:accountName/:projectSlug/build/:buildVersion
  • DELETEDelete project build cache/projects/:accountName/:projectSlug/buildcache
  • GETGet project deployments/projects/:accountName/:projectSlug/deployments?recordsNumber=0
  • GETGet project history/projects/:accountName/:projectSlug/history?recordsNumber=0&startBuildId=0&branch=string
  • GETGet project settings/projects/:accountName/:projectSlug/settings
  • PUTUpdate project build number/projects/:accountName/:projectSlug/settings/build-number
  • GETGet project environment variables/projects/:accountName/:projectSlug/settings/environment-variables
  • PUTUpdate project environment variables/projects/:accountName/:projectSlug/settings/environment-variables
  • GETGet project settings in YAML/projects/:accountName/:projectSlug/settings/yaml
  • PUTUpdate project settings in YAML/projects/:accountName/:projectSlug/settings/yaml

Deployment

  • POSTStart deployment/deployments
  • PUTCancel deployment/deployments/stop
  • GETGet deployment/deployments/:deploymentId

Environment

  • GETGet environments/environments
  • PUTUpdate environment/environments
  • POSTAdd environment/environments
  • DELETEDelete environment/environments/:deploymentEnvironmentId
  • GETGet environment deployments/environments/:deploymentEnvironmentId/deployments
  • GETGet environment settings/environments/:deploymentEnvironmentId/settings

API details

Base URL
https://ci.appveyor.com/api
Authentication
An API key in the Authorization header
Operations
53 operations on 37 pathsGET 27PUT 11DELETE 8POST 7
Main resources
Project 21User 8Build 6Environment 6Role 5Collaborator 4Deployment 3
Response formats
application/json application/xml
Description format
Swagger 2.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the AppVeyor REST API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AppVeyor REST API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get collaborators” (GET /collaborators), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AppVeyor REST API?

AppVeyor is a hosted continuous integration service which runs on Microsoft Windows. The AppVeyor REST API provides a RESTful way to interact with the… It is listed under Developer tools and has 53 endpoints.

Who publishes the AppVeyor REST API?

It is listed from AppVeyor's public API description (an OpenAPI document), not published by AppVeyor on Swastik Codes. Anyone who controls appveyor.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AppVeyor REST API?

Requests go to https://ci.appveyor.com/api. Endpoint paths are added to this base URL.

How do I authenticate with the AppVeyor REST API?

With an API key in the Authorization header.

How many endpoints does the AppVeyor REST API have?

53 operations on 37 paths (27 GET, 11 PUT, 8 DELETE, 7 POST). The largest groups are Project, User, Build, Environment.

Is forking the AppVeyor REST API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.