Azure DevOps Pipeline Artifacts API

Operations for accessing artifacts from pipeline runs

Documentation

Specifications

Other Resources

OpenAPI Specification

microsoft-azure-devops-pipeline-artifacts-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Azure DevOps Artifacts Attachments Pipeline Artifacts API
  description: 'REST API for managing packages, feeds, and artifact dependencies in Azure Artifacts. Supports NuGet, npm, Maven, Python, and Universal package formats in private or public feeds. Enables programmatic management of package feeds, discovery of packages and their versions, and lifecycle operations such as deprecating or deleting package versions.

    '
  version: '7.1'
  contact:
    name: Microsoft Azure DevOps
    url: https://learn.microsoft.com/en-us/rest/api/azure/devops/artifacts/
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
- url: https://feeds.dev.azure.com/{organization}/{project}/_apis
  description: Azure DevOps Artifacts API (project-scoped)
  variables:
    organization:
      description: Azure DevOps organization name or ID
      default: myorganization
    project:
      description: Azure DevOps project name or ID
      default: myproject
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Pipeline Artifacts
  description: Operations for accessing artifacts from pipeline runs
paths:
  /pipelines/{pipelineId}/runs/{runId}/artifacts:
    get:
      operationId: artifacts_list
      summary: Azure DevOps List run artifacts
      description: 'Returns a list of artifacts published by a specific pipeline run. Artifacts can include compiled binaries, test results, container images, or any other files published using the PublishBuildArtifacts or PublishPipelineArtifact task.

        '
      tags:
      - Pipeline Artifacts
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/PipelineId'
      - name: runId
        in: path
        required: true
        description: Numeric ID of the pipeline run
        schema:
          type: integer
      - name: artifactName
        in: query
        required: false
        description: Filter by a specific artifact name
        schema:
          type: string
      - name: $expand
        in: query
        required: false
        description: Expand additional artifact details
        schema:
          type: string
          enum:
          - none
          - signedContent
      responses:
        '200':
          description: List of run artifacts returned successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/Artifact'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Forbidden:
      description: Forbidden - insufficient permissions to perform this operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Unauthorized - missing or invalid authentication credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Not found - the requested resource does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    Artifact:
      type: object
      description: An artifact produced by a pipeline run
      properties:
        name:
          type: string
          description: Name of the artifact
          example: drop
        signedContent:
          type: object
          description: Signed content reference for secure artifact downloads
          properties:
            url:
              type: string
              format: uri
              description: Download URL for the artifact
            signatureExpires:
              type: string
              format: date-time
        fileContainerResource:
          type: object
          description: File container resource details
          properties:
            type:
              type: string
            url:
              type: string
              format: uri
        url:
          type: string
          format: uri
    ApiError:
      type: object
      description: Error response from the Azure DevOps API
      properties:
        id:
          type: string
          format: uuid
        message:
          type: string
        typeName:
          type: string
        typeKey:
          type: string
        errorCode:
          type: integer
        eventId:
          type: integer
  parameters:
    ApiVersion:
      name: api-version
      in: query
      required: true
      description: Azure DevOps REST API version. Use 7.1 for the latest stable version.
      schema:
        type: string
        default: '7.1'
        enum:
        - '7.1'
        - '7.0'
        - '6.0'
    PipelineId:
      name: pipelineId
      in: path
      required: true
      description: Numeric ID of the pipeline
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Azure AD OAuth 2.0 bearer token
    basicAuth:
      type: http
      scheme: basic
      description: Basic authentication using a Personal Access Token (PAT). Use any string as the username and the PAT as the password, then base64-encode the result.