Artifacts

List artifacts

Lists all of the artifacts in the supplied Octopus Deploy Space, from all releases. The results will be sorted by date from most recently to least recently created.

get/spaces/{spaceIdentifier}/artifacts

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/artifacts
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdentifierstring required

Identifier (ID or slug) of the space

Query parameters

idsstring[]

List of Artifact IDs which if specified, filters the result to only include Artifacts with matching IDs.

orderstring

asc or desc

partialNamestring

A partial or complete name to search on. This will perform a "contains" style match against the supplied name or name-fragment

regardingstring

An ID of a resource to filter on. Only artifacts related to this resource will be returned. It can be the ID of the following: Release, RunbookSnapshot, Deployment, Runbook Run, Server Task, Project, Environment or Tenant.

skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items to take. Defaults to 30

Response

A paginated list of Artifacts

Idstring

Gets or sets a unique identifier for this resource.

ItemsPerPageinteger
ItemTypestring

The type of item in this list

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

LastPageNumberinteger
Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

NumberOfPagesinteger
TotalResultsinteger

Example response

{
  "Items": [
    {
      "Filename": "Performance Test Results.csv",
      "Links": {
        "Self": "/api/..."
      },
      "LogCorrelationId": "0c5a872485ac4b10857939a92d082e67",
      "SpaceId": "Spaces-1"
    }
  ],
  "ItemsPerPage": 30,
  "ItemType": "Artifact",
  "LastPageNumber": 1,
  "Links": {
    "Self": "/api/..."
  },
  "NumberOfPages": 2,
  "TotalResults": 42
}

Changes

No recorded changes to this operation across all 13 revisions of this API.