# Appveyor

AppVeyor is a hosted continuous integration service for building and deploying applications.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 14
- **Triggers:** 0
- **Slug:** `APPVEYOR`
- **Version:** 20260227_00

## Tools

### Delete Build

**Slug:** `APPVEYOR_DELETE_BUILD`

Tool to delete a build by ID. Use when you need to remove a build from AppVeyor. The API returns 204 No Content on successful deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `buildId` | integer | Yes | The ID of the build to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Build Log

**Slug:** `APPVEYOR_DOWNLOAD_BUILD_LOG`

Tool to download the build log for a specific job. Use when you need to retrieve the log output from a completed or running build job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jobId` | string | Yes | Build job ID (`jobId` property of `BuildJob`) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Build Artifacts

**Slug:** `APPVEYOR_GET_BUILD_ARTIFACTS`

Tool to get the list of artifacts for a specific build job. Use when you need to retrieve artifacts after a job completes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jobId` | string | Yes | The ID of the build job to retrieve artifacts from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Build By Version

**Slug:** `APPVEYOR_GET_BUILD_BY_VERSION`

Tool to get a specific project build by version number. Use when you need to retrieve detailed information about a build using its version identifier.

#### Input Parameters

| Parameter | Type | Required | 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 (when logged in). The user account is also the accountName property of UserAccount. |
| `projectSlug` | string | Yes | Project slug (URL-friendly identifier for the project). |
| `buildVersion` | string | Yes | Build version (version property of Build, e.g., '1.0.233'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Environments

**Slug:** `APPVEYOR_GET_ENVIRONMENTS`

Tool to get a list of all deployment environments. Use when you need to enumerate available environments before creating deployments.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project Branch Status Badge

**Slug:** `APPVEYOR_GET_PROJECT_BRANCH_STATUS_BADGE`

Tool to get a project branch status badge image. Returns a PNG or SVG badge image showing the build status for a specific project branch.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `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. |
| `buildBranch` | string | Yes | Build branch name (e.g., 'master', 'develop'). |
| `failingText` | string | No | Text to show in badge when build is failing. |
| `passingText` | string | No | Text to show in badge when build is passing. |
| `pendingText` | string | No | Text to show in badge when build is pending. |
| `statusBadgeId` | string | Yes | ID of the status badge (statusBadgeId from ProjectWithConfiguration). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Projects

**Slug:** `APPVEYOR_GET_PROJECTS`

Tool to get a list of all projects for the authenticated account. Use after authentication to enumerate available projects.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project Status Badge

**Slug:** `APPVEYOR_GET_PROJECT_STATUS_BADGE`

Tool to get project status badge image. Use when you need to retrieve the status badge for displaying project build status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `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. |
| `failingText` | string | No | Text to show in badge when build is failing. |
| `passingText` | string | No | Text to show in badge when build is passing. |
| `pendingText` | string | No | Text to show in badge when build is pending. |
| `statusBadgeId` | string | Yes | ID of the status badge (statusBadgeId from ProjectWithConfiguration). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Public Project Status Badge

**Slug:** `APPVEYOR_GET_PUBLIC_PROJECT_STATUS_BADGE`

Tool to get status badge image for a project with a public repository. Use when you need to retrieve a build status badge for display or documentation purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `svg` | boolean | No | Return an SVG image instead of PNG? Exclusive with 'retina' |
| `branch` | string | No | Repository branch to get badge for |
| `retina` | boolean | No | Return a larger image suitable for retina displays? Exclusive with 'svg' |
| `repoSlug` | string | Yes | Slug (URL component) of repository |
| `failingText` | string | No | Text to show in badge when build is failing |
| `passingText` | string | No | Text to show in badge when build is passing |
| `pendingText` | string | No | Text to show in badge when build is pending |
| `repoAccountName` | string | Yes | Account name with repository provider |
| `badgeRepoProvider` | string ("bitBucket" | "gitHub") | Yes | Repository provider supported for badges |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Role

**Slug:** `APPVEYOR_GET_ROLE`

Tool to retrieve details of a specific role. Use when you need to inspect permissions and metadata of a role by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_id` | integer | Yes | Unique identifier of the role to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Roles

**Slug:** `APPVEYOR_GET_ROLES`

Tool to retrieve all roles in the account. Use when you need to enumerate available roles before assigning permissions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Invitations

**Slug:** `APPVEYOR_GET_USER_INVITATIONS`

Tool to retrieve all pending user invitations in the account. Use when you need to list all outstanding invitations sent to potential team members.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Users

**Slug:** `APPVEYOR_GET_USERS`

Tool to retrieve all users in the account. Use when you need to list all team users in your AppVeyor account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Collaborators

**Slug:** `APPVEYOR_LIST_COLLABORATORS`

Tool to retrieve all collaborators in the account. Use when you need to list all team collaborators in your AppVeyor account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |