> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # appveyor > Appveyor CI/CD **Server path:** `/appveyor` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | | [`appveyor_add_environment`](#appveyor_add_environment) | Add environment | | [`appveyor_add_project`](#appveyor_add_project) | Add project | | [`appveyor_add_role`](#appveyor_add_role) | Add role | | [`appveyor_cancel_build`](#appveyor_cancel_build) | Cancel build | | [`appveyor_cancel_deployment`](#appveyor_cancel_deployment) | Cancel deployment | | [`appveyor_cancel_user_invitation`](#appveyor_cancel_user_invitation) | Cancel user invitation | | [`appveyor_delete_collaborator`](#appveyor_delete_collaborator) | Delete collaborator | | [`appveyor_delete_environment`](#appveyor_delete_environment) | Delete environment | | [`appveyor_delete_project`](#appveyor_delete_project) | Delete project | | [`appveyor_delete_project_build_cache`](#appveyor_delete_project_build_cache) | Delete project build cache | | [`appveyor_delete_role`](#appveyor_delete_role) | Delete role | | [`appveyor_delete_user`](#appveyor_delete_user) | Delete user | | [`appveyor_encrypt_value`](#appveyor_encrypt_value) | Encrypt a value for use in StoredValue. | | [`appveyor_get_build_artifact`](#appveyor_get_build_artifact) | Download build artifact | | [`appveyor_get_build_artifacts`](#appveyor_get_build_artifacts) | Get build artifacts | | [`appveyor_get_build_log`](#appveyor_get_build_log) | Download build log | | [`appveyor_get_collaborator`](#appveyor_get_collaborator) | Get collaborator | | [`appveyor_get_collaborators`](#appveyor_get_collaborators) | Get collaborators | | [`appveyor_get_deployment`](#appveyor_get_deployment) | Get deployment | | [`appveyor_get_environment_deployments`](#appveyor_get_environment_deployments) | Get environment deployments | | [`appveyor_get_environment_settings`](#appveyor_get_environment_settings) | Get environment settings | | [`appveyor_get_environments`](#appveyor_get_environments) | Get environments | | [`appveyor_get_project_artifact`](#appveyor_get_project_artifact) | Get last successful build artifact | | [`appveyor_get_project_branch_status_badge`](#appveyor_get_project_branch_status_badge) | Get project branch status badge image | | [`appveyor_get_project_build_by_version`](#appveyor_get_project_build_by_version) | Get project build by version | | [`appveyor_get_project_deployments`](#appveyor_get_project_deployments) | Get project deployments | | [`appveyor_get_project_environment_variables`](#appveyor_get_project_environment_variables) | Get project environment variables | | [`appveyor_get_project_history`](#appveyor_get_project_history) | Get project history | | [`appveyor_get_project_last_build`](#appveyor_get_project_last_build) | Get project last build | | [`appveyor_get_project_last_build_branch`](#appveyor_get_project_last_build_branch) | Get project last branch build | | [`appveyor_get_project_settings`](#appveyor_get_project_settings) | Get project settings | | [`appveyor_get_project_settings_yaml`](#appveyor_get_project_settings_yaml) | Get project settings in YAML | | [`appveyor_get_project_status_badge`](#appveyor_get_project_status_badge) | Get project status badge image | | [`appveyor_get_projects`](#appveyor_get_projects) | Get projects | | [`appveyor_get_public_project_status_badge`](#appveyor_get_public_project_status_badge) | Get status badge image for a project with a public repository | | [`appveyor_get_role`](#appveyor_get_role) | Get role | | [`appveyor_get_roles`](#appveyor_get_roles) | Get roles | | [`appveyor_get_user`](#appveyor_get_user) | Get user | | [`appveyor_get_user_invitations`](#appveyor_get_user_invitations) | Get user invitations | | [`appveyor_get_users`](#appveyor_get_users) | Get users | | [`appveyor_invite_user`](#appveyor_invite_user) | Invite user | | [`appveyor_join_account`](#appveyor_join_account) | Join Account | | [`appveyor_re_run_build`](#appveyor_re_run_build) | Re-run build | | [`appveyor_start_build`](#appveyor_start_build) | Start build of branch most recent commit | | [`appveyor_start_deployment`](#appveyor_start_deployment) | Start deployment | | [`appveyor_update_collaborator`](#appveyor_update_collaborator) | Update collaborator | | [`appveyor_update_environment`](#appveyor_update_environment) | Update environment | | [`appveyor_update_project`](#appveyor_update_project) | Update project | | [`appveyor_update_project_build_number`](#appveyor_update_project_build_number) | Update project build number | | [`appveyor_update_project_environment_variables`](#appveyor_update_project_environment_variables) | Update project environment variables | | [`appveyor_update_project_settings_yaml`](#appveyor_update_project_settings_yaml) | Update project settings in YAML | | [`appveyor_update_role`](#appveyor_update_role) | Update role | | [`appveyor_update_user`](#appveyor_update_user) | Update user | *** ## appveyor\_add\_environment Add environment **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------ | | `name` | string | Yes | — | The name value | | `provider` | string | Yes | — | The provider value | | `settings` | object | Yes | — | The settings value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name value" }, "provider": { "type": "string", "description": "The provider value", "enum": [ "Agent", "AzureBlob", "AzureCS", "AzureWebJob", "BinTray", "FTP", "GitHub", "NuGet", "S3", "SqlDatabase", "WebDeploy", "Webhook" ] }, "settings": { "type": "object", "description": "The settings value", "properties": { "providerSettings": { "type": "array", "items": { "type": "object" }, "description": "Provider Settings" }, "environmentVariables": { "type": "array", "items": { "type": "object" }, "description": "Environment Variables" }, "notifications": { "type": "array", "items": { "type": "object" }, "description": "The notifications value" } } } }, "required": [ "PCID", "name", "provider", "settings" ] } ``` *** ## appveyor\_add\_project Add project **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | | `repositoryAuthentication` | string | No | — | Repository Authentication | | `repositoryName` | string | Yes | — | URL when repositoryProvider is git, mercurial, subversion username/project when repositoryProvider is gitHub | | `repositoryPassword` | string | No | — | Required if repositoryAuthentication is credentials | | `repositoryProvider` | string | Yes | — | Repository Provider | | `repositoryUsername` | string | No | — | Required if repositoryAuthentication is credentials | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repositoryAuthentication": { "type": "string", "description": "Repository Authentication", "enum": [ "credentials", "ssh" ] }, "repositoryName": { "type": "string", "description": "URL when repositoryProvider is git, mercurial, subversion username/project when repositoryProvider is gitHub" }, "repositoryPassword": { "type": "string", "description": "Required if repositoryAuthentication is credentials" }, "repositoryProvider": { "type": "string", "description": "Repository Provider", "enum": [ "bitBucket", "git", "gitHub", "gitLab", "kiln", "mercurial", "stash", "subversion", "vso" ] }, "repositoryUsername": { "type": "string", "description": "Required if repositoryAuthentication is credentials" } }, "required": [ "PCID", "repositoryName", "repositoryProvider" ] } ``` *** ## appveyor\_add\_role Add role **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------- | | `name` | string | Yes | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "name" ] } ``` *** ## appveyor\_cancel\_build Cancel build **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `buildVersion` | string | Yes | — | Build Version (`version` property of `Build`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "buildVersion": { "type": "string", "description": "Build Version (`version` property of `Build`)" } }, "required": [ "PCID", "accountName", "projectSlug", "buildVersion" ] } ``` *** ## appveyor\_cancel\_deployment Cancel deployment **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | ------------- | | `deploymentId` | integer | Yes | — | Deployment Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deploymentId": { "type": "integer", "description": "Deployment Id" } }, "required": [ "PCID", "deploymentId" ] } ``` *** ## appveyor\_cancel\_user\_invitation Cancel user invitation **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ------------------ | | `userInvitationId` | string | Yes | — | User Invitation ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userInvitationId": { "type": "string", "description": "User Invitation ID" } }, "required": [ "PCID", "userInvitationId" ] } ``` *** ## appveyor\_delete\_collaborator Delete collaborator **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ----------- | | `userId` | integer | Yes | — | User ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "integer", "description": "User ID" } }, "required": [ "PCID", "userId" ] } ``` *** ## appveyor\_delete\_environment Delete environment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------- | | `deploymentEnvironmentId` | integer | Yes | — | Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deploymentEnvironmentId": { "type": "integer", "description": "Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`)" } }, "required": [ "PCID", "deploymentEnvironmentId" ] } ``` *** ## appveyor\_delete\_project Delete project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" } }, "required": [ "PCID", "accountName", "projectSlug" ] } ``` *** ## appveyor\_delete\_project\_build\_cache Delete project build cache **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" } }, "required": [ "PCID", "accountName", "projectSlug" ] } ``` *** ## appveyor\_delete\_role Delete role **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ----------- | | `roleId` | integer | Yes | — | Role ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "roleId": { "type": "integer", "description": "Role ID" } }, "required": [ "PCID", "roleId" ] } ``` *** ## appveyor\_delete\_user Delete user **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ----------- | | `userId` | integer | Yes | — | User ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "integer", "description": "User ID" } }, "required": [ "PCID", "userId" ] } ``` *** ## appveyor\_encrypt\_value Encrypt a value for use in StoredValue. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------- | | `plainValue` | string | No | — | Plain Value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "plainValue": { "type": "string", "description": "Plain Value" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_get\_build\_artifact Download build artifact **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `jobId` | string | Yes | — | Build ID (`jobId` property of `BuildJob`) | | `artifactFileName` | string | Yes | — | File name (or path) of a build artifact file. Corresponds to the `fileName` property of `ArtifactModel`. URL-encoding of slashes in parameter values is optional. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "Build ID (`jobId` property of `BuildJob`)" }, "artifactFileName": { "type": "string", "description": "File name (or path) of a build artifact file. Corresponds to the `fileName` property of `ArtifactModel`. URL-encoding of slashes in parameter values is optional." } }, "required": [ "PCID", "jobId", "artifactFileName" ] } ``` *** ## appveyor\_get\_build\_artifacts Get build artifacts **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------------------------------- | | `jobId` | string | Yes | — | Build ID (`jobId` property of `BuildJob`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "Build ID (`jobId` property of `BuildJob`)" } }, "required": [ "PCID", "jobId" ] } ``` *** ## appveyor\_get\_build\_log Download build log **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------------------------------- | | `jobId` | string | Yes | — | Build ID (`jobId` property of `BuildJob`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "Build ID (`jobId` property of `BuildJob`)" } }, "required": [ "PCID", "jobId" ] } ``` *** ## appveyor\_get\_collaborator Get collaborator **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ----------- | | `userId` | integer | Yes | — | User ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "integer", "description": "User ID" } }, "required": [ "PCID", "userId" ] } ``` *** ## appveyor\_get\_collaborators Get collaborators ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_get\_deployment Get deployment **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | ------------------------------------------------------- | | `deploymentId` | integer | Yes | — | Deployment ID (`deploymentId` property of `Deployment`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deploymentId": { "type": "integer", "description": "Deployment ID (`deploymentId` property of `Deployment`)" } }, "required": [ "PCID", "deploymentId" ] } ``` *** ## appveyor\_get\_environment\_deployments Get environment deployments **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------- | | `deploymentEnvironmentId` | integer | Yes | — | Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deploymentEnvironmentId": { "type": "integer", "description": "Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`)" } }, "required": [ "PCID", "deploymentEnvironmentId" ] } ``` *** ## appveyor\_get\_environment\_settings Get environment settings **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------- | | `deploymentEnvironmentId` | integer | Yes | — | Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deploymentEnvironmentId": { "type": "integer", "description": "Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`)" } }, "required": [ "PCID", "deploymentEnvironmentId" ] } ``` *** ## appveyor\_get\_environments Get environments ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_get\_project\_artifact Get last successful build artifact **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `artifactFileName` | string | Yes | — | File name (or path) of a build artifact file. Corresponds to the `fileName` property of `ArtifactModel`. URL-encoding of slashes in parameter values is optional. | | `branch` | string | No | — | Repository Branch | | `tag` | string | No | — | A git (or other VCS) tag | | `job` | string | No | — | Name of the build job. | | `all` | boolean | No | — | Include not only `successful`, but also jobs with `failed`, and `cancelled` status. | | `pr` | boolean | No | — | Include 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "artifactFileName": { "type": "string", "description": "File name (or path) of a build artifact file. Corresponds to the `fileName` property of `ArtifactModel`. URL-encoding of slashes in parameter values is optional." }, "branch": { "type": "string", "description": "Repository Branch" }, "tag": { "type": "string", "description": "A git (or other VCS) tag" }, "job": { "type": "string", "description": "Name of the build job." }, "all": { "type": "boolean", "description": "Include not only `successful`, but also jobs with `failed`, and `cancelled` status." }, "pr": { "type": "boolean", "description": "Include 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." } }, "required": [ "PCID", "accountName", "projectSlug", "artifactFileName" ] } ``` *** ## appveyor\_get\_project\_branch\_status\_badge Get project branch status badge image **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------- | | `statusBadgeId` | string | Yes | — | ID of the status badge (`statusBadgeId` from `ProjectWithConfiguration`). | | `buildBranch` | string | Yes | — | Build Branch | | `svg` | boolean | No | — | Return an SVG image instead of PNG? Exclusive with `retina`. | | `retina` | boolean | No | — | Return a larger image suitable for retina displays? Exclusive with `svg`. | | `passingText` | string | No | — | Text to show in badge when build is passing. | | `failingText` | string | No | — | Text to show in badge when build is failing. | | `pendingText` | string | No | — | Text to show in badge when build is pending. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "statusBadgeId": { "type": "string", "description": "ID of the status badge (`statusBadgeId` from `ProjectWithConfiguration`)." }, "buildBranch": { "type": "string", "description": "Build Branch" }, "svg": { "type": "boolean", "description": "Return an SVG image instead of PNG? Exclusive with `retina`." }, "retina": { "type": "boolean", "description": "Return a larger image suitable for retina displays? Exclusive with `svg`." }, "passingText": { "type": "string", "description": "Text to show in badge when build is passing." }, "failingText": { "type": "string", "description": "Text to show in badge when build is failing." }, "pendingText": { "type": "string", "description": "Text to show in badge when build is pending." } }, "required": [ "PCID", "statusBadgeId", "buildBranch" ] } ``` *** ## appveyor\_get\_project\_build\_by\_version Get project build by version **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `buildVersion` | string | Yes | — | Build Version (`version` property of `Build`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "buildVersion": { "type": "string", "description": "Build Version (`version` property of `Build`)" } }, "required": [ "PCID", "accountName", "projectSlug", "buildVersion" ] } ``` *** ## appveyor\_get\_project\_deployments Get project deployments **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `recordsNumber` | integer | Yes | — | Number 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "recordsNumber": { "type": "integer", "description": "Number 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." } }, "required": [ "PCID", "accountName", "projectSlug", "recordsNumber" ] } ``` *** ## appveyor\_get\_project\_environment\_variables Get project environment variables **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" } }, "required": [ "PCID", "accountName", "projectSlug" ] } ``` *** ## appveyor\_get\_project\_history Get project history **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `recordsNumber` | integer | Yes | — | Number 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. | | `startBuildId` | integer | No | — | Maximum `buildId` to include in the results (exclusive). | | `branch` | string | No | — | Repository Branch | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "recordsNumber": { "type": "integer", "description": "Number 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." }, "startBuildId": { "type": "integer", "description": "Maximum `buildId` to include in the results (exclusive)." }, "branch": { "type": "string", "description": "Repository Branch" } }, "required": [ "PCID", "accountName", "projectSlug", "recordsNumber" ] } ``` *** ## appveyor\_get\_project\_last\_build Get project last build **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" } }, "required": [ "PCID", "accountName", "projectSlug" ] } ``` *** ## appveyor\_get\_project\_last\_build\_branch Get project last branch build **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `buildBranch` | string | Yes | — | Build Branch | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "buildBranch": { "type": "string", "description": "Build Branch" } }, "required": [ "PCID", "accountName", "projectSlug", "buildBranch" ] } ``` *** ## appveyor\_get\_project\_settings Get project settings **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" } }, "required": [ "PCID", "accountName", "projectSlug" ] } ``` *** ## appveyor\_get\_project\_settings\_yaml Get project settings in YAML **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" } }, "required": [ "PCID", "accountName", "projectSlug" ] } ``` *** ## appveyor\_get\_project\_status\_badge Get project status badge image **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------- | | `statusBadgeId` | string | Yes | — | ID of the status badge (`statusBadgeId` from `ProjectWithConfiguration`). | | `svg` | boolean | No | — | Return an SVG image instead of PNG? Exclusive with `retina`. | | `retina` | boolean | No | — | Return a larger image suitable for retina displays? Exclusive with `svg`. | | `passingText` | string | No | — | Text to show in badge when build is passing. | | `failingText` | string | No | — | Text to show in badge when build is failing. | | `pendingText` | string | No | — | Text to show in badge when build is pending. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "statusBadgeId": { "type": "string", "description": "ID of the status badge (`statusBadgeId` from `ProjectWithConfiguration`)." }, "svg": { "type": "boolean", "description": "Return an SVG image instead of PNG? Exclusive with `retina`." }, "retina": { "type": "boolean", "description": "Return a larger image suitable for retina displays? Exclusive with `svg`." }, "passingText": { "type": "string", "description": "Text to show in badge when build is passing." }, "failingText": { "type": "string", "description": "Text to show in badge when build is failing." }, "pendingText": { "type": "string", "description": "Text to show in badge when build is pending." } }, "required": [ "PCID", "statusBadgeId" ] } ``` *** ## appveyor\_get\_projects Get projects ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_get\_public\_project\_status\_badge Get status badge image for a project with a public repository **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------- | | `badgeRepoProvider` | string | Yes | — | Repository provider supported for badges | | `repoAccountName` | string | Yes | — | Account name with repository provider | | `repoSlug` | string | Yes | — | Slug (URL component) of repository. | | `branch` | string | No | — | Repository Branch | | `svg` | boolean | No | — | Return an SVG image instead of PNG? Exclusive with `retina`. | | `retina` | boolean | No | — | Return a larger image suitable for retina displays? Exclusive with `svg`. | | `passingText` | string | No | — | Text to show in badge when build is passing. | | `failingText` | string | No | — | Text to show in badge when build is failing. | | `pendingText` | string | No | — | Text to show in badge when build is pending. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "badgeRepoProvider": { "type": "string", "description": "Repository provider supported for badges", "enum": [ "bitBucket", "gitHub" ] }, "repoAccountName": { "type": "string", "description": "Account name with repository provider" }, "repoSlug": { "type": "string", "description": "Slug (URL component) of repository." }, "branch": { "type": "string", "description": "Repository Branch" }, "svg": { "type": "boolean", "description": "Return an SVG image instead of PNG? Exclusive with `retina`." }, "retina": { "type": "boolean", "description": "Return a larger image suitable for retina displays? Exclusive with `svg`." }, "passingText": { "type": "string", "description": "Text to show in badge when build is passing." }, "failingText": { "type": "string", "description": "Text to show in badge when build is failing." }, "pendingText": { "type": "string", "description": "Text to show in badge when build is pending." } }, "required": [ "PCID", "badgeRepoProvider", "repoAccountName", "repoSlug" ] } ``` *** ## appveyor\_get\_role Get role **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ----------- | | `roleId` | integer | Yes | — | Role ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "roleId": { "type": "integer", "description": "Role ID" } }, "required": [ "PCID", "roleId" ] } ``` *** ## appveyor\_get\_roles Get roles ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_get\_user Get user **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ----------- | | `userId` | integer | Yes | — | User ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "integer", "description": "User ID" } }, "required": [ "PCID", "userId" ] } ``` *** ## appveyor\_get\_user\_invitations Get user invitations ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_get\_users Get users ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_invite\_user Invite user **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | --------------- | | `email` | string | Yes | — | The email value | | `roleId` | integer | Yes | — | Role Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email": { "type": "string", "description": "The email value" }, "roleId": { "type": "integer", "description": "Role Id" } }, "required": [ "PCID", "email", "roleId" ] } ``` *** ## appveyor\_join\_account Join Account **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------- | | `invitationId` | string | Yes | — | Invitation Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "invitationId": { "type": "string", "description": "Invitation Id" } }, "required": [ "PCID", "invitationId" ] } ``` *** ## appveyor\_re\_run\_build Re-run build **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | `buildId` | integer | Yes | — | Build Id | | `reRunIncomplete` | boolean | No | — | Set `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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "buildId": { "type": "integer", "description": "Build Id" }, "reRunIncomplete": { "type": "boolean", "description": "Set `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." } }, "required": [ "PCID", "buildId" ] } ``` *** ## appveyor\_start\_build Start build of branch most recent commit **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ------------------------------------------- | | `accountName` | string | Yes | — | Account Name | | `branch` | string | No | — | The branch value | | `commitId` | string | No | — | Commit Id | | `environmentVariables` | object | No | — | Environment Variables | | `projectSlug` | string | Yes | — | Project Slug | | `pullRequestId` | integer | No | — | Can not be used with `branch` or `commitId` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "Account Name" }, "branch": { "type": "string", "description": "The branch value" }, "commitId": { "type": "string", "description": "Commit Id" }, "environmentVariables": { "type": "object", "description": "Environment Variables" }, "projectSlug": { "type": "string", "description": "Project Slug" }, "pullRequestId": { "type": "integer", "description": "Can not be used with `branch` or `commitId`" } }, "required": [ "PCID", "accountName", "projectSlug" ] } ``` *** ## appveyor\_start\_deployment Start deployment **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------ | -------- | ------- | --------------------------------------------------------------- | | `accountName` | string | Yes | — | Account Name | | `buildJobId` | string | No | — | Optional job id with artifacts if build contains multiple jobs. | | `buildVersion` | string | Yes | — | Build to deploy | | `environmentName` | string | Yes | — | Environment Name | | `environmentVariables` | object | No | — | Environment Variables | | `projectSlug` | string | Yes | — | Project Slug | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "Account Name" }, "buildJobId": { "type": "string", "description": "Optional job id with artifacts if build contains multiple jobs." }, "buildVersion": { "type": "string", "description": "Build to deploy" }, "environmentName": { "type": "string", "description": "Environment Name" }, "environmentVariables": { "type": "object", "description": "Environment Variables" }, "projectSlug": { "type": "string", "description": "Project Slug" } }, "required": [ "PCID", "accountName", "buildVersion", "environmentName", "projectSlug" ] } ``` *** ## appveyor\_update\_collaborator Update collaborator **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ----------- | | `roleId` | integer | Yes | — | Role Id | | `userId` | integer | Yes | — | User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "roleId": { "type": "integer", "description": "Role Id" }, "userId": { "type": "integer", "description": "User Id" } }, "required": [ "PCID", "roleId", "userId" ] } ``` *** ## appveyor\_update\_environment Update environment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ---------- | -------- | ------- | --------------------------------------------------- | | `accountId` | integer | No | — | Account Id | | `deploymentEnvironmentId` | integer | No | — | Deployment Environment Id | | `environmentAccessKey` | string | No | — | Environment Access Key | | `name` | string | No | — | The name value | | `projects` | object\[] | No | — | Projects available for selection in UI | | `projectsMode` | integer | No | — | Project selection mode for deployment environments. | | `provider` | string | No | — | The provider value | | `securityDescriptor` | object | No | — | Security Descriptor | | `selectedProjects` | integer\[] | No | — | Project IDs of selected projects | | `settings` | object | No | — | The settings value | | `tags` | string | No | — | The tags value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountId": { "type": "integer", "description": "Account Id" }, "deploymentEnvironmentId": { "type": "integer", "description": "Deployment Environment Id" }, "environmentAccessKey": { "type": "string", "description": "Environment Access Key" }, "name": { "type": "string", "description": "The name value" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "integer", "description": "Project Id" }, "name": { "type": "string", "description": "The name value" }, "isSelected": { "type": "boolean", "description": "Is Selected" } }, "required": [ "projectId", "name", "isSelected" ] }, "description": "Projects available for selection in UI" }, "projectsMode": { "type": "integer", "description": "Project selection mode for deployment environments.", "enum": [ 0, 1, 2 ] }, "provider": { "type": "string", "description": "The provider value", "enum": [ "Agent", "AzureBlob", "AzureCS", "AzureWebJob", "BinTray", "FTP", "GitHub", "NuGet", "S3", "SqlDatabase", "WebDeploy", "Webhook" ] }, "securityDescriptor": { "type": "object", "description": "Security Descriptor", "properties": { "accessRightDefinitions": { "type": "array", "items": { "type": "object" }, "description": "Access Right Definitions" }, "roleAces": { "type": "array", "items": { "type": "object" }, "description": "Role Aces" } } }, "selectedProjects": { "type": "array", "items": { "type": "integer" }, "description": "Project IDs of selected projects" }, "settings": { "type": "object", "description": "The settings value", "properties": { "providerSettings": { "type": "array", "items": { "type": "object" }, "description": "Provider Settings" }, "environmentVariables": { "type": "array", "items": { "type": "object" }, "description": "Environment Variables" }, "notifications": { "type": "array", "items": { "type": "object" }, "description": "The notifications value" } } }, "tags": { "type": "string", "description": "The tags value" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_update\_project Update project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------------- | ------- | -------- | ------- | ---------------------------------------- | | `accountName` | string | No | — | Account Name | | `alwaysBuildClosedPullRequests` | boolean | No | — | Always Build Closed Pull Requests | | `buildPriority` | integer | No | — | Build Priority | | `configuration` | object | No | — | The configuration value | | `enableDeploymentInPullRequests` | boolean | No | — | Enable Deployment In Pull Requests | | `enableSecureVariablesInPullRequests` | boolean | No | — | Enable Secure Variables In Pull Requests | | `isPrivate` | boolean | No | — | Is Private | | `name` | string | No | — | The name value | | `nextBuildNumber` | integer | No | — | Next Build Number | | `nuGetFeed` | object | No | — | NuGet feed configuration for the project | | `projectId` | integer | Yes | — | Project Id | | `repositoryName` | string | No | — | Repository Name | | `repositoryScm` | string | No | — | Repository Scm | | `repositoryType` | string | No | — | Repository Type | | `saveBuildCacheInPullRequests` | boolean | No | — | Save Build Cache In Pull Requests | | `scheduleCrontabExpression` | string | No | — | Schedule Crontab Expression | | `securityDescriptor` | object | No | — | Security Descriptor | | `skipBranchesWithoutAppveyorYml` | boolean | No | — | Skip Branches Without Appveyor Yml | | `slug` | string | No | — | The slug value | | `versionFormat` | string | No | — | Version Format | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "Account Name" }, "alwaysBuildClosedPullRequests": { "type": "boolean", "description": "Always Build Closed Pull Requests" }, "buildPriority": { "type": "integer", "description": "Build Priority" }, "configuration": { "type": "object", "description": "The configuration value", "properties": { "doNotIncrementBuildNumberOnPullRequests": { "type": "boolean", "description": "Do Not Increment Build Number On Pull Requests" }, "hotFixScripts": { "type": "array", "items": { "type": "object" }, "description": "Hot Fix Scripts" }, "initScripts": { "type": "array", "items": { "type": "object" }, "description": "Init Scripts" }, "branchesMode": { "type": "string", "description": "Branches Mode", "enum": [ "exclude", "include" ] }, "includeBranches": { "type": "array", "items": { "type": "object" }, "description": "Include Branches" }, "excludeBranches": { "type": "array", "items": { "type": "object" }, "description": "Exclude Branches" }, "skipTags": { "type": "boolean", "description": "Skip Tags" }, "skipNonTags": { "type": "boolean", "description": "Skip Non Tags" }, "skipBranchWithPullRequests": { "type": "boolean", "description": "Skip Branch With Pull Requests" }, "skipCommitsFiles": { "type": "array", "items": { "type": "object" }, "description": "Skip Commits Files" }, "onlyCommitsFiles": { "type": "array", "items": { "type": "object" }, "description": "Only Commits Files" }, "cloneScripts": { "type": "array", "items": { "type": "object" }, "description": "Clone Scripts" }, "onBuildSuccessScripts": { "type": "array", "items": { "type": "object" }, "description": "On Build Success Scripts" }, "onBuildErrorScripts": { "type": "array", "items": { "type": "object" }, "description": "On Build Error Scripts" }, "onBuildFinishScripts": { "type": "array", "items": { "type": "object" }, "description": "On Build Finish Scripts" }, "patchAssemblyInfo": { "type": "boolean", "description": "Patch Assembly Info" }, "assemblyInfoFile": { "type": "string", "description": "Assembly Info File" }, "assemblyVersionFormat": { "type": "string", "description": "Assembly Version Format" }, "assemblyFileVersionFormat": { "type": "string", "description": "Assembly File Version Format" }, "assemblyInformationalVersionFormat": { "type": "string", "description": "Assembly Informational Version Format" }, "patchDotnetCsproj": { "type": "boolean", "description": "Patch Dotnet Csproj" }, "dotnetCsprojFile": { "type": "string", "description": "Dotnet Csproj File" }, "dotnetCsprojVersionFormat": { "type": "string", "description": "Dotnet Csproj Version Format" }, "dotnetCsprojAssemblyVersionFormat": { "type": "string", "description": "Dotnet Csproj Assembly Version Format" }, "dotnetCsprojFileVersionFormat": { "type": "string", "description": "Dotnet Csproj File Version Format" }, "dotnetCsprojInformationalVersionFormat": { "type": "string", "description": "Dotnet Csproj Informational Version Format" }, "dotnetCsprojPackageVersionFormat": { "type": "string", "description": "Dotnet Csproj Package Version Format" }, "maxJobs": { "type": "integer", "description": "Max Jobs" }, "buildCloud": { "type": "array", "items": { "type": "object" }, "description": "Build Cloud" }, "operatingSystem": { "type": "array", "items": { "type": "object" }, "description": "Operating System" }, "services": { "type": "array", "items": { "type": "object" }, "description": "The services value" }, "stacks": { "type": "array", "items": { "type": "string", "enum": [ "unknown" ] }, "description": "The stacks value" }, "cloneFolder": { "type": "string", "description": "Clone Folder" }, "shallowClone": { "type": "boolean", "description": "Shallow Clone" }, "forceHttpsClone": { "type": "boolean", "description": "Force Https Clone" }, "cloneDepth": { "type": "integer", "description": "Clone Depth" }, "environmentVariables": { "type": "array", "items": { "type": "object" }, "description": "Environment Variables" }, "environmentVariablesMatrix": { "type": "array", "items": { "type": "object" }, "description": "Environment Variables Matrix" }, "installScripts": { "type": "array", "items": { "type": "object" }, "description": "Install Scripts" }, "hostsEntries": { "type": "array", "items": { "type": "object" }, "description": "Hosts Entries" }, "cacheEntries": { "type": "array", "items": { "type": "object" }, "description": "Cache Entries" }, "configureNuGetProjectSource": { "type": "boolean", "description": "Configure Nu Get Project Source" }, "configureNuGetAccountSource": { "type": "boolean", "description": "Configure Nu Get Account Source" }, "disableNuGetPublishOnPullRequests": { "type": "boolean", "description": "Disable Nu Get Publish On Pull Requests" }, "disableNuGetPublishForOctopusPackages": { "type": "boolean", "description": "Disable Nu Get Publish For Octopus Packages" }, "buildMode": { "type": "string", "description": "Build Mode", "enum": [ "msbuild", "none", "script" ] }, "platform": { "type": "array", "items": { "type": "object" }, "description": "The platform value" }, "configuration": { "type": "array", "items": { "type": "object" }, "description": "The configuration value" }, "msBuildProjectFileName": { "type": "string", "description": "Ms Build Project File Name" }, "packageWebApplicationProjects": { "type": "boolean", "description": "Package Web Application Projects" }, "packageWebApplicationProjectsXCopy": { "type": "boolean", "description": "Package Web Application Projects X Copy" }, "packageWebApplicationProjectsBeanstalk": { "type": "boolean", "description": "Package Web Application Projects Beanstalk" }, "packageWebApplicationProjectsOctopus": { "type": "boolean", "description": "Package Web Application Projects Octopus" }, "packageAzureCloudServiceProjects": { "type": "boolean", "description": "Package Azure Cloud Service Projects" }, "packageNuGetProjects": { "type": "boolean", "description": "Package Nu Get Projects" }, "packageNuGetSymbols": { "type": "boolean", "description": "Package Nu Get Symbols" }, "packageAspNetCoreProjects": { "type": "boolean", "description": "Package Asp Net Core Projects" }, "packageDotnetConsoleProjects": { "type": "boolean", "description": "Package Dotnet Console Projects" }, "includeNuGetReferences": { "type": "boolean", "description": "Include Nu Get References" }, "msBuildInParallel": { "type": "boolean", "description": "Ms Build In Parallel" }, "msBuildVerbosity": { "type": "string", "description": "Ms Build Verbosity", "enum": [ "quiet", "minimal", "normal", "detailed" ] }, "buildScripts": { "type": "array", "items": { "type": "object" }, "description": "Only set/used when `buildMode` is `script`." }, "beforeBuildScripts": { "type": "array", "items": { "type": "object" }, "description": "Before Build Scripts" }, "beforePackageScripts": { "type": "array", "items": { "type": "object" }, "description": "Before Package Scripts" }, "afterBuildScripts": { "type": "array", "items": { "type": "object" }, "description": "After Build Scripts" }, "testMode": { "type": "string", "description": "Test Mode", "enum": [ "auto", "none", "script" ] }, "testAssemblies": { "type": "array", "items": { "type": "object" }, "description": "Test Assemblies" }, "testCategoriesMode": { "type": "string", "description": "Test Categories Mode", "enum": [ "exclude", "include" ] }, "testCategories": { "type": "array", "items": { "type": "object" }, "description": "Test Categories" }, "testCategoriesMatrix": { "type": "array", "items": { "type": "object" }, "description": "Test Categories Matrix" }, "testScripts": { "type": "array", "items": { "type": "object" }, "description": "Only set/used when `testMode` is `script`." }, "beforeTestScripts": { "type": "array", "items": { "type": "object" }, "description": "Before Test Scripts" }, "afterTestScripts": { "type": "array", "items": { "type": "object" }, "description": "After Test Scripts" }, "deployMode": { "type": "string", "description": "Deploy Mode", "enum": [ "providers", "none", "script" ] }, "deployments": { "type": "array", "items": { "type": "object" }, "description": "The deployments value" }, "deployScripts": { "type": "array", "items": { "type": "object" }, "description": "Deploy Scripts" }, "beforeDeployScripts": { "type": "array", "items": { "type": "object" }, "description": "Before Deploy Scripts" }, "afterDeployScripts": { "type": "array", "items": { "type": "object" }, "description": "After Deploy Scripts" }, "xamarinRegisterAndroidProduct": { "type": "boolean", "description": "Xamarin Register Android Product" }, "xamarinRegisterIosProduct": { "type": "boolean", "description": "Xamarin Register Ios Product" }, "matrixFastFinish": { "type": "boolean", "description": "Matrix Fast Finish" }, "matrixAllowFailures": { "type": "array", "items": { "type": "object" }, "description": "Although the names and values are not enforced, the combinations which are meaningful are documented at https://www.appveyor.com/docs/build-configuration/#allow-failing-jobs" }, "matrixExclude": { "type": "array", "items": { "type": "object" }, "description": "Matrix Exclude" }, "matrixOnly": { "type": "array", "items": { "type": "object" }, "description": "Matrix Only" }, "matrixExcept": { "type": "array", "items": { "type": "object" }, "description": "Matrix Except" }, "artifacts": { "type": "array", "items": { "type": "object" }, "description": "The artifacts value" }, "notifications": { "type": "array", "items": { "type": "object" }, "description": "The notifications value" } } }, "enableDeploymentInPullRequests": { "type": "boolean", "description": "Enable Deployment In Pull Requests" }, "enableSecureVariablesInPullRequests": { "type": "boolean", "description": "Enable Secure Variables In Pull Requests" }, "isPrivate": { "type": "boolean", "description": "Is Private" }, "name": { "type": "string", "description": "The name value" }, "nextBuildNumber": { "type": "integer", "description": "Next Build Number" }, "nuGetFeed": { "type": "object", "description": "NuGet feed configuration for the project" }, "projectId": { "type": "integer", "description": "Project Id" }, "repositoryName": { "type": "string", "description": "Repository Name" }, "repositoryScm": { "type": "string", "description": "Repository Scm", "enum": [ "git", "mercurial", "subversion" ] }, "repositoryType": { "type": "string", "description": "Repository Type", "enum": [ "bitBucket", "git", "gitHub", "gitLab", "kiln", "mercurial", "stash", "subversion", "vso" ] }, "saveBuildCacheInPullRequests": { "type": "boolean", "description": "Save Build Cache In Pull Requests" }, "scheduleCrontabExpression": { "type": "string", "description": "Schedule Crontab Expression" }, "securityDescriptor": { "type": "object", "description": "Security Descriptor", "properties": { "accessRightDefinitions": { "type": "array", "items": { "type": "object" }, "description": "Access Right Definitions" }, "roleAces": { "type": "array", "items": { "type": "object" }, "description": "Role Aces" } } }, "skipBranchesWithoutAppveyorYml": { "type": "boolean", "description": "Skip Branches Without Appveyor Yml" }, "slug": { "type": "string", "description": "The slug value" }, "versionFormat": { "type": "string", "description": "Version Format" } }, "required": [ "PCID", "projectId" ] } ``` *** ## appveyor\_update\_project\_build\_number Update project build number **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `nextBuildNumber` | integer | Yes | — | Next Build Number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "nextBuildNumber": { "type": "integer", "description": "Next Build Number" } }, "required": [ "PCID", "accountName", "projectSlug", "nextBuildNumber" ] } ``` *** ## appveyor\_update\_project\_environment\_variables Update project environment variables **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `body` | object\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "body": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "value": { "type": "object", "description": "The value value" } }, "required": [ "name", "value" ] }, "description": "Request body" } }, "required": [ "PCID", "accountName", "projectSlug", "body" ] } ``` *** ## appveyor\_update\_project\_settings\_yaml Update project settings in YAML **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `body` | string | Yes | — | The 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](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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "body": { "type": "string", "description": "The 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." } }, "required": [ "PCID", "accountName", "projectSlug", "body" ] } ``` *** ## appveyor\_update\_role Update role **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ---------------- | | `groups` | object\[] | No | — | The groups value | | `isSystem` | boolean | No | — | Is System | | `name` | string | Yes | — | The name value | | `roleId` | integer | Yes | — | Role Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Account", "BuildEnvironment", "Deny", "Environments", "Projects", "Roles", "User", "Users" ], "description": "The name value" }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Available permission names. The names correspond to the following groups: #### AccountPermission - ManageApplicationAuthorizations - UpdateAccountDetails - UpdateBillingDetails #### BuildEnvironmentPermission - ConfigureBuildEnvironment #### DenyPermission - DenyAllProjectsEnvironments #### EnvironmentsPermission - DeployToEnvironment - ManageEnvironments - UpdateEnvironmentSettings #### ProjectsPermission - ManageProjects - RunProjectBuild - UpdateProjectSettings #### RolesPermission - AddRole - DeleteRole - UpdateRoleDetails #### UserPermission - ConfigureApiKeys #### UsersPermission - AddUser - DeleteUser - UpdateUserDetails " }, "description": { "type": "string" }, "allowed": { "type": "boolean", "description": "State of the named permission. `true` to allow, `false` to deny, missing to inherit. " } } }, "description": "The permissions value" } }, "required": [ "name", "permissions" ] }, "description": "The groups value" }, "isSystem": { "type": "boolean", "description": "Is System" }, "name": { "type": "string", "description": "The name value" }, "roleId": { "type": "integer", "description": "Role Id" } }, "required": [ "PCID", "name", "roleId" ] } ``` *** ## appveyor\_update\_user Update user **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | -------------------------- | | `accountId` | integer | No | — | Account Id | | `accountName` | string | No | — | Account Name | | `created` | string | No | — | The created value | | `email` | string | Yes | — | The email value | | `fullName` | string | Yes | — | Full Name | | `isCollaborator` | boolean | No | — | Is Collaborator | | `isOwner` | boolean | No | — | Is Owner | | `pageSize` | integer | No | — | Number of results per page | | `password` | string | No | — | The password value | | `roleId` | integer | No | — | Role Id | | `roleName` | string | No | — | Role Name | | `twoFactorAuthEnabled` | boolean | No | — | Two Factor Auth Enabled | | `updated` | string | No | — | The updated value | | `userId` | integer | Yes | — | User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountId": { "type": "integer", "description": "Account Id" }, "accountName": { "type": "string", "description": "Account Name" }, "created": { "type": "string", "description": "The created value" }, "email": { "type": "string", "description": "The email value" }, "fullName": { "type": "string", "description": "Full Name" }, "isCollaborator": { "type": "boolean", "description": "Is Collaborator" }, "isOwner": { "type": "boolean", "description": "Is Owner" }, "pageSize": { "type": "integer", "description": "Number of results per page" }, "password": { "type": "string", "description": "The password value" }, "roleId": { "type": "integer", "description": "Role Id" }, "roleName": { "type": "string", "description": "Role Name" }, "twoFactorAuthEnabled": { "type": "boolean", "description": "Two Factor Auth Enabled" }, "updated": { "type": "string", "description": "The updated value" }, "userId": { "type": "integer", "description": "User Id" } }, "required": [ "PCID", "email", "fullName", "userId" ] } ```