NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Appveyor connects to a Nagent workspace with an API key. Once it is connected, agents can call 14 Appveyor actions, such as "Get Build Artifacts", "Get Build By Version" and "Get Environments". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Appveyor, with input parameters and output schema.
APPVEYOR_DELETE_BUILDTool 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
The ID of the build to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APPVEYOR_DOWNLOAD_BUILD_LOGTool 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
Build job ID (`jobId` property of `BuildJob`)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APPVEYOR_GET_BUILD_ARTIFACTSTool to get the list of artifacts for a specific build job. Use when you need to retrieve artifacts after a job completes.
Input parameters
The ID of the build job to retrieve artifacts from.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APPVEYOR_GET_BUILD_BY_VERSIONTool 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
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.
Project slug (URL-friendly identifier for the project).
Build version (version property of Build, e.g., '1.0.233').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APPVEYOR_GET_ENVIRONMENTSTool to get a list of all deployment environments. Use when you need to enumerate available environments before creating deployments.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APPVEYOR_GET_PROJECT_BRANCH_STATUS_BADGETool 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
Return an SVG image instead of PNG? Exclusive with retina.
Return a larger image suitable for retina displays? Exclusive with svg.
Build branch name (e.g., 'master', 'develop').
Text to show in badge when build is failing.
Text to show in badge when build is passing.
Text to show in badge when build is pending.
ID of the status badge (statusBadgeId from ProjectWithConfiguration).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APPVEYOR_GET_PROJECTSTool to get a list of all projects for the authenticated account. Use after authentication to enumerate available projects.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APPVEYOR_GET_PROJECT_STATUS_BADGETool to get project status badge image. Use when you need to retrieve the status badge for displaying project build status.
Input parameters
Return an SVG image instead of PNG? Exclusive with retina.
Return a larger image suitable for retina displays? Exclusive with svg.
Text to show in badge when build is failing.
Text to show in badge when build is passing.
Text to show in badge when build is pending.
ID of the status badge (statusBadgeId from ProjectWithConfiguration).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APPVEYOR_GET_PUBLIC_PROJECT_STATUS_BADGETool 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
Return an SVG image instead of PNG? Exclusive with 'retina'
Repository branch to get badge for
Return a larger image suitable for retina displays? Exclusive with 'svg'
Slug (URL component) of repository
Text to show in badge when build is failing
Text to show in badge when build is passing
Text to show in badge when build is pending
Account name with repository provider
Repository provider supported for badges
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APPVEYOR_GET_ROLETool to retrieve details of a specific role. Use when you need to inspect permissions and metadata of a role by ID.
Input parameters
Unique identifier of the role to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APPVEYOR_GET_ROLESTool to retrieve all roles in the account. Use when you need to enumerate available roles before assigning permissions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APPVEYOR_GET_USER_INVITATIONSTool to retrieve all pending user invitations in the account. Use when you need to list all outstanding invitations sent to potential team members.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APPVEYOR_GET_USERSTool to retrieve all users in the account. Use when you need to list all team users in your AppVeyor account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APPVEYOR_LIST_COLLABORATORSTool to retrieve all collaborators in the account. Use when you need to list all team collaborators in your AppVeyor account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 14 Appveyor actions on Nagent, including "Get Build Artifacts", "Get Build By Version" and "Get Environments". Get Build Artifacts: Get the list of artifacts for a specific build job. Each action is listed on this page with its input parameters and its output.
Appveyor connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get Build Artifacts takes 1 required input: jobId. It returns data, error and successful.