Skip to main content
Server path: /appveyor | Type: Application | PCID required: Yes

Tools

ToolDescription
appveyor_add_environmentAdd environment
appveyor_add_projectAdd project
appveyor_add_roleAdd role
appveyor_cancel_buildCancel build
appveyor_cancel_deploymentCancel deployment
appveyor_cancel_user_invitationCancel user invitation
appveyor_delete_collaboratorDelete collaborator
appveyor_delete_environmentDelete environment
appveyor_delete_projectDelete project
appveyor_delete_project_build_cacheDelete project build cache
appveyor_delete_roleDelete role
appveyor_delete_userDelete user
appveyor_encrypt_valueEncrypt a value for use in StoredValue.
appveyor_get_build_artifactDownload build artifact
appveyor_get_build_artifactsGet build artifacts
appveyor_get_build_logDownload build log
appveyor_get_collaboratorGet collaborator
appveyor_get_collaboratorsGet collaborators
appveyor_get_deploymentGet deployment
appveyor_get_environment_deploymentsGet environment deployments
appveyor_get_environment_settingsGet environment settings
appveyor_get_environmentsGet environments
appveyor_get_project_artifactGet last successful build artifact
appveyor_get_project_branch_status_badgeGet project branch status badge image
appveyor_get_project_build_by_versionGet project build by version
appveyor_get_project_deploymentsGet project deployments
appveyor_get_project_environment_variablesGet project environment variables
appveyor_get_project_historyGet project history
appveyor_get_project_last_buildGet project last build
appveyor_get_project_last_build_branchGet project last branch build
appveyor_get_project_settingsGet project settings
appveyor_get_project_settings_yamlGet project settings in YAML
appveyor_get_project_status_badgeGet project status badge image
appveyor_get_projectsGet projects
appveyor_get_public_project_status_badgeGet status badge image for a project with a public repository
appveyor_get_roleGet role
appveyor_get_rolesGet roles
appveyor_get_userGet user
appveyor_get_user_invitationsGet user invitations
appveyor_get_usersGet users
appveyor_invite_userInvite user
appveyor_join_accountJoin Account
appveyor_re_run_buildRe-run build
appveyor_start_buildStart build of branch most recent commit
appveyor_start_deploymentStart deployment
appveyor_update_collaboratorUpdate collaborator
appveyor_update_environmentUpdate environment
appveyor_update_projectUpdate project
appveyor_update_project_build_numberUpdate project build number
appveyor_update_project_environment_variablesUpdate project environment variables
appveyor_update_project_settings_yamlUpdate project settings in YAML
appveyor_update_roleUpdate role
appveyor_update_userUpdate user

appveyor_add_environment

Add environment Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name value
providerstringYesThe provider value
settingsobjectYesThe settings value

appveyor_add_project

Add project Parameters:
ParameterTypeRequiredDefaultDescription
repositoryAuthenticationstringNoRepository Authentication
repositoryNamestringYesURL when repositoryProvider is git, mercurial, subversion username/project when repositoryProvider is gitHub
repositoryPasswordstringNoRequired if repositoryAuthentication is credentials
repositoryProviderstringYesRepository Provider
repositoryUsernamestringNoRequired if repositoryAuthentication is credentials

appveyor_add_role

Add role Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name value

appveyor_cancel_build

Cancel build Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug
buildVersionstringYesBuild Version (version property of Build)

appveyor_cancel_deployment

Cancel deployment Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdintegerYesDeployment Id

appveyor_cancel_user_invitation

Cancel user invitation Parameters:
ParameterTypeRequiredDefaultDescription
userInvitationIdstringYesUser Invitation ID

appveyor_delete_collaborator

Delete collaborator Parameters:
ParameterTypeRequiredDefaultDescription
userIdintegerYesUser ID

appveyor_delete_environment

Delete environment Parameters:
ParameterTypeRequiredDefaultDescription
deploymentEnvironmentIdintegerYesDeployment Environment ID (deploymentEnvironmentId property of DeploymentEnvironment)

appveyor_delete_project

Delete project Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug

appveyor_delete_project_build_cache

Delete project build cache Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug

appveyor_delete_role

Delete role Parameters:
ParameterTypeRequiredDefaultDescription
roleIdintegerYesRole ID

appveyor_delete_user

Delete user Parameters:
ParameterTypeRequiredDefaultDescription
userIdintegerYesUser ID

appveyor_encrypt_value

Encrypt a value for use in StoredValue. Parameters:
ParameterTypeRequiredDefaultDescription
plainValuestringNoPlain Value

appveyor_get_build_artifact

Download build artifact Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYesBuild ID (jobId property of BuildJob)
artifactFileNamestringYesFile name (or path) of a build artifact file. Corresponds to the fileName property of ArtifactModel. URL-encoding of slashes in parameter values is optional.

appveyor_get_build_artifacts

Get build artifacts Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYesBuild ID (jobId property of BuildJob)

appveyor_get_build_log

Download build log Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYesBuild ID (jobId property of BuildJob)

appveyor_get_collaborator

Get collaborator Parameters:
ParameterTypeRequiredDefaultDescription
userIdintegerYesUser ID

appveyor_get_collaborators

Get collaborators

appveyor_get_deployment

Get deployment Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdintegerYesDeployment ID (deploymentId property of Deployment)

appveyor_get_environment_deployments

Get environment deployments Parameters:
ParameterTypeRequiredDefaultDescription
deploymentEnvironmentIdintegerYesDeployment Environment ID (deploymentEnvironmentId property of DeploymentEnvironment)

appveyor_get_environment_settings

Get environment settings Parameters:
ParameterTypeRequiredDefaultDescription
deploymentEnvironmentIdintegerYesDeployment Environment ID (deploymentEnvironmentId property of DeploymentEnvironment)

appveyor_get_environments

Get environments

appveyor_get_project_artifact

Get last successful build artifact Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug
artifactFileNamestringYesFile name (or path) of a build artifact file. Corresponds to the fileName property of ArtifactModel. URL-encoding of slashes in parameter values is optional.
branchstringNoRepository Branch
tagstringNoA git (or other VCS) tag
jobstringNoName of the build job.
allbooleanNoInclude not only successful, but also jobs with failed, and cancelled status.
prbooleanNoInclude PR builds in the search results? true - take artifact from PR builds only; false - do not look for artifact in PR builds; default/unspecified - look for artifact in both PR an non-PR builds.

appveyor_get_project_branch_status_badge

Get project branch status badge image Parameters:
ParameterTypeRequiredDefaultDescription
statusBadgeIdstringYesID of the status badge (statusBadgeId from ProjectWithConfiguration).
buildBranchstringYesBuild Branch
svgbooleanNoReturn an SVG image instead of PNG? Exclusive with retina.
retinabooleanNoReturn a larger image suitable for retina displays? Exclusive with svg.
passingTextstringNoText to show in badge when build is passing.
failingTextstringNoText to show in badge when build is failing.
pendingTextstringNoText to show in badge when build is pending.

appveyor_get_project_build_by_version

Get project build by version Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug
buildVersionstringYesBuild Version (version property of Build)

appveyor_get_project_deployments

Get project deployments Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug
recordsNumberintegerYesNumber of results to include in the response. getProjectDeployments is documented to have a maximum of 20. It currently returns 500 Internal Server Error for recordsNumber <= 5. In the past it has returned 500 Internal Server Error for many different values which did not match the value used by the ci.appveyor.com web interface at the time. As of 2018-09-08, the value used by the web interface is 10.

appveyor_get_project_environment_variables

Get project environment variables Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug

appveyor_get_project_history

Get project history Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug
recordsNumberintegerYesNumber of results to include in the response. getProjectDeployments is documented to have a maximum of 20. It currently returns 500 Internal Server Error for recordsNumber <= 5. In the past it has returned 500 Internal Server Error for many different values which did not match the value used by the ci.appveyor.com web interface at the time. As of 2018-09-08, the value used by the web interface is 10.
startBuildIdintegerNoMaximum buildId to include in the results (exclusive).
branchstringNoRepository Branch

appveyor_get_project_last_build

Get project last build Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug

appveyor_get_project_last_build_branch

Get project last branch build Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug
buildBranchstringYesBuild Branch

appveyor_get_project_settings

Get project settings Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug

appveyor_get_project_settings_yaml

Get project settings in YAML Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug

appveyor_get_project_status_badge

Get project status badge image Parameters:
ParameterTypeRequiredDefaultDescription
statusBadgeIdstringYesID of the status badge (statusBadgeId from ProjectWithConfiguration).
svgbooleanNoReturn an SVG image instead of PNG? Exclusive with retina.
retinabooleanNoReturn a larger image suitable for retina displays? Exclusive with svg.
passingTextstringNoText to show in badge when build is passing.
failingTextstringNoText to show in badge when build is failing.
pendingTextstringNoText to show in badge when build is pending.

appveyor_get_projects

Get projects

appveyor_get_public_project_status_badge

Get status badge image for a project with a public repository Parameters:
ParameterTypeRequiredDefaultDescription
badgeRepoProviderstringYesRepository provider supported for badges
repoAccountNamestringYesAccount name with repository provider
repoSlugstringYesSlug (URL component) of repository.
branchstringNoRepository Branch
svgbooleanNoReturn an SVG image instead of PNG? Exclusive with retina.
retinabooleanNoReturn a larger image suitable for retina displays? Exclusive with svg.
passingTextstringNoText to show in badge when build is passing.
failingTextstringNoText to show in badge when build is failing.
pendingTextstringNoText to show in badge when build is pending.

appveyor_get_role

Get role Parameters:
ParameterTypeRequiredDefaultDescription
roleIdintegerYesRole ID

appveyor_get_roles

Get roles

appveyor_get_user

Get user Parameters:
ParameterTypeRequiredDefaultDescription
userIdintegerYesUser ID

appveyor_get_user_invitations

Get user invitations

appveyor_get_users

Get users

appveyor_invite_user

Invite user Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesThe email value
roleIdintegerYesRole Id

appveyor_join_account

Join Account Parameters:
ParameterTypeRequiredDefaultDescription
invitationIdstringYesInvitation Id

appveyor_re_run_build

Re-run build Parameters:
ParameterTypeRequiredDefaultDescription
buildIdintegerYesBuild Id
reRunIncompletebooleanNoSet reRunIncomplete set to false (default value) for full build re-run. Set it set to true to rerun only failed or cancelled jobs in multijob build.

appveyor_start_build

Start build of branch most recent commit Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAccount Name
branchstringNoThe branch value
commitIdstringNoCommit Id
environmentVariablesobjectNoEnvironment Variables
projectSlugstringYesProject Slug
pullRequestIdintegerNoCan not be used with branch or commitId

appveyor_start_deployment

Start deployment Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAccount Name
buildJobIdstringNoOptional job id with artifacts if build contains multiple jobs.
buildVersionstringYesBuild to deploy
environmentNamestringYesEnvironment Name
environmentVariablesobjectNoEnvironment Variables
projectSlugstringYesProject Slug

appveyor_update_collaborator

Update collaborator Parameters:
ParameterTypeRequiredDefaultDescription
roleIdintegerYesRole Id
userIdintegerYesUser Id

appveyor_update_environment

Update environment Parameters:
ParameterTypeRequiredDefaultDescription
accountIdintegerNoAccount Id
deploymentEnvironmentIdintegerNoDeployment Environment Id
environmentAccessKeystringNoEnvironment Access Key
namestringNoThe name value
projectsobject[]NoProjects available for selection in UI
projectsModeintegerNoProject selection mode for deployment environments.
providerstringNoThe provider value
securityDescriptorobjectNoSecurity Descriptor
selectedProjectsinteger[]NoProject IDs of selected projects
settingsobjectNoThe settings value
tagsstringNoThe tags value

appveyor_update_project

Update project Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringNoAccount Name
alwaysBuildClosedPullRequestsbooleanNoAlways Build Closed Pull Requests
buildPriorityintegerNoBuild Priority
configurationobjectNoThe configuration value
enableDeploymentInPullRequestsbooleanNoEnable Deployment In Pull Requests
enableSecureVariablesInPullRequestsbooleanNoEnable Secure Variables In Pull Requests
isPrivatebooleanNoIs Private
namestringNoThe name value
nextBuildNumberintegerNoNext Build Number
nuGetFeedobjectNoNuGet feed configuration for the project
projectIdintegerYesProject Id
repositoryNamestringNoRepository Name
repositoryScmstringNoRepository Scm
repositoryTypestringNoRepository Type
saveBuildCacheInPullRequestsbooleanNoSave Build Cache In Pull Requests
scheduleCrontabExpressionstringNoSchedule Crontab Expression
securityDescriptorobjectNoSecurity Descriptor
skipBranchesWithoutAppveyorYmlbooleanNoSkip Branches Without Appveyor Yml
slugstringNoThe slug value
versionFormatstringNoVersion Format

appveyor_update_project_build_number

Update project build number Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug
nextBuildNumberintegerYesNext Build Number

appveyor_update_project_environment_variables

Update project environment variables Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug
bodyobject[]YesRequest body

appveyor_update_project_settings_yaml

Update project settings in YAML Parameters:
ParameterTypeRequiredDefaultDescription
accountNamestringYesAppVeyor account name on which to operate. Accounts for which a user has access are listed on the Security page of the user profile (when logged in). The user account is also the accountName property of UserAccount.
projectSlugstringYesProject Slug
bodystringYesThe body of requests should contain YAML data. It is unclear how to specify this since the OpenAPI spec requires schema without type for in: body parameters and does not allow type: file in schema. See https://github.com/OAI/OpenAPI-Specification/issues/326 swagger-codegen (for Java, probably others) allows a binary string body parameter with non-application/json consumes to be passed through in the request body without conversion to JSON.

appveyor_update_role

Update role Parameters:
ParameterTypeRequiredDefaultDescription
groupsobject[]NoThe groups value
isSystembooleanNoIs System
namestringYesThe name value
roleIdintegerYesRole Id

appveyor_update_user

Update user Parameters:
ParameterTypeRequiredDefaultDescription
accountIdintegerNoAccount Id
accountNamestringNoAccount Name
createdstringNoThe created value
emailstringYesThe email value
fullNamestringYesFull Name
isCollaboratorbooleanNoIs Collaborator
isOwnerbooleanNoIs Owner
pageSizeintegerNoNumber of results per page
passwordstringNoThe password value
roleIdintegerNoRole Id
roleNamestringNoRole Name
twoFactorAuthEnabledbooleanNoTwo Factor Auth Enabled
updatedstringNoThe updated value
userIdintegerYesUser Id