Artifacts

Modify an existing artifact.

put/artifacts/{id}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/artifacts/{id}
  • 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

idstring required

The ID of the artifact.

Response

Artifacts are files like documents and test results that may be stored alongside a release.

Createdstring date-time

Gets or sets the time at which the artifact was created.

Filenamestring required

Gets or sets the filename of the Artifact to create

Idstring

Gets or sets a unique identifier for this resource.

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.

Linksobject

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

LogCorrelationIdstring

Gets the correlationId of the log block in which the artifact was captured

ServerTaskIdstring

Gets or sets the server task with which this artifact is associated.

Sourcestring

Gets or sets a short summary of the source of this attachment. This will typically be the name of a step/machine, or "Uploaded by [username]" if the attachment was uploaded by a person.

SpaceIdstring

Example response

{
  "Filename": "Performance Test Results.csv",
  "Links": {
    "Self": "/api/..."
  },
  "LogCorrelationId": "0c5a872485ac4b10857939a92d082e67",
  "SpaceId": "Spaces-1"
}

Changes

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