AppVeyor REST API

Name: AppVeyor REST API API
Brand: AppVeyor REST API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsCi CdapiKey53 EndpointsREST

For Agents

Trigger AppVeyor builds, manage projects and deployments, and administer collaborators across hosted Windows, Linux, and macOS CI runners.

Quickstart

Get started with AppVeyor REST API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"trigger an AppVeyor build for a branch"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with AppVeyor REST API API.

Queue a new build for a project from a branch or commit via /builds

Cancel a running build or roll back a failed deployment

Create and update projects with build configuration through /projects

Manage deployments and deployment environments under /deployments and /environments

GET STARTED

Start building with AppVeyor REST API API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for AppVeyor REST API, keeping it validated and agent-ready.

The AppVeyor REST API drives AppVeyor's hosted continuous integration service for Windows, Linux, and macOS builds. Through 53 operations spanning 37 paths, it lets you create and configure projects, queue and cancel builds, manage deployments and environments, and administer team collaborators and roles. AppVeyor pairs cleanly with .NET, Windows-native, and cross-platform pipelines that need scripted access to build artefacts and deployment lifecycles.

Use Cases

Patterns agents use AppVeyor REST API API for, with concrete tasks.

★ Cross-Platform Build Trigger from External Systems

When a non-AppVeyor system — a custom dashboard, an internal release tool, or another CI provider — needs to kick off an AppVeyor build, it calls /builds with the project slug, branch, and optional commit. The API returns the build id which downstream systems poll for status. This is the standard pattern when AppVeyor sits inside a larger orchestration that includes other CI providers or release tooling.

POST /builds with accountName, projectSlug, and branch=master to queue a new build

Deployment Promotion Workflow

After a successful AppVeyor build, a release manager promotes the resulting artefact through staging and production environments via the /deployments endpoint. The API tracks deployment history per environment so audit logs and rollback decisions are scriptable. Pair this with /environments to read the current state of each target before promoting.

POST /deployments with environmentName=production and buildVersion from the latest successful build

Build Status Dashboard

An internal dashboard polls /projects and /projects/{accountName}/{projectSlug}/history to render build health across teams, surfacing pass/fail trends, average build duration, and the last failing commit per project. Combined with /collaborators it can attribute regressions to the responsible engineer for follow-up.

GET /projects to list all projects, then for each call /projects/{accountName}/{projectSlug}/history?recordsNumber=10 and aggregate pass rate

AI Agent Build Orchestration

An AI agent uses Jentic to orchestrate AppVeyor builds inside a larger release flow — triggering builds, polling status, fetching logs on failure, and posting summaries to a Slack channel. Jentic vaults the AppVeyor bearer token so the agent only sees scoped credentials at execution time.

Search Jentic for 'trigger appveyor build', call POST /builds, then poll /builds/{accountName}/{projectSlug}/{buildVersion} until status is 'success' or 'failed'

Key Endpoints

53 endpoints — the appveyor rest api drives appveyor's hosted continuous integration service for windows, linux, and macos builds.

METHOD

PATH

DESCRIPTION

GET

/projects

List all projects in the account

POST

/builds

Queue a new build for a project

DELETE

/builds/{accountName}/{projectSlug}

Cancel the currently running build

POST

/deployments

Trigger a deployment of a build to an environment

GET

/environments

List configured deployment environments

GET

/collaborators

List collaborators on the account

GET

/roles

List role definitions for collaborator assignment

GET

/projects

List all projects in the account

POST

/builds

Queue a new build for a project

DELETE

/builds/{accountName}/{projectSlug}

Cancel the currently running build

POST

/deployments

Trigger a deployment of a build to an environment

GET

/environments

List configured deployment environments

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

AppVeyor uses a long-lived API token. Jentic stores it encrypted in the MAXsystem vault and only attaches it to the Authorization header at execution time, so the agent never reads the raw token.

Intent-based discovery

Agents search Jentic with intents like 'trigger appveyor build' or 'cancel running build' and Jentic returns the matching operation with parameters and response schema.

Time to first call

Direct integration: half a day reading docs and writing an HTTP client. Through Jentic: under 30 minutes — search, load, execute against 53 already-modeled operations.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

CircleCI API

Cloud CI service with stronger Linux/macOS focus and a similar build-trigger API

Pick CircleCI when the workload is Linux or macOS first; pick AppVeyor when Windows or .NET is the primary target.

Complementary

GitHub REST API

Repository and webhook source that AppVeyor builds against

Use GitHub to read commit and PR context; use AppVeyor to run the matching build and report status back.

Alternative

Bitrise API

CI/CD focused on mobile (iOS, Android) with a similar trigger and status surface

Pick Bitrise when the target is mobile; pick AppVeyor for Windows-native or .NET cross-platform builds.

FAQs

Specific to using AppVeyor REST API API through Jentic.

What authentication does the AppVeyor REST API use?

It uses an API token passed via the apiToken security scheme — typically as Authorization: Bearer {token}. You generate the token from the AppVeyor account settings page. Through Jentic the token is stored encrypted in the MAXsystem vault and attached only at execution time.

Can I trigger an AppVeyor build for a specific commit through the API?

Yes. POST /builds accepts accountName, projectSlug, branch, and optionally commitId. The response returns the queued build with its build id and version, which you can then poll via /builds/{accountName}/{projectSlug}/{buildVersion} to track status.

How do I cancel a running AppVeyor build?

Send DELETE /builds/{accountName}/{projectSlug}. AppVeyor cancels the currently running or queued build for that project. The endpoint returns no body on success; verify by re-reading the build record afterward.

What are the rate limits for the AppVeyor REST API?

AppVeyor does not publish hard rate limits in the spec; in practice, the API is tolerant of CI burst patterns but applies per-plan monthly build minute quotas. If a request is throttled the API returns 429. Check the AppVeyor pricing page for the build minute allocation on your plan.

How do I deploy a successful AppVeyor build through Jentic?

Run pip install jentic, search 'trigger appveyor deployment', and load POST /deployments. Execute it with environmentName, accountName, projectSlug, and buildVersion. Jentic handles the bearer token and returns the deployment id for polling.

Is this the official AppVeyor API spec?

The spec is maintained by the community at github.com/kevinoid/appveyor-swagger and tracks the official AppVeyor REST API. AppVeyor itself does not publish an OpenAPI document, so this third-party spec is the structured source the API community uses.