Reporting

Get an XML report of deployments

get/{spaceId}/reporting/deployments/xml

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/reporting/deployments/xml
  • 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

spaceIdstring required

The ID of the space containing the resource(s).

Query parameters

environmentIdstring

An Environment ID, to limit the set of Deployments to deployed to a particular Environment. Example: Environments-1

fromCompletedTimestring date-time

A date/time, to limit the set of Deployments to those which completed after a given moment. Example: 2000-01-01T01:23

fromStartTimestring date-time

A date/time, to limit the set of Deployments to those which started after a given moment. Example: 2000-01-01T01:23

projectIdstring

A Project ID, to limit the set of Deployments to those from a particular Project. Example: Projects-1

toCompletedTimestring date-time

A date/time, to limit the set of Deployments to those which completed before a given moment. Example: 2000-01-01T01:23

toStartTimestring date-time

A date/time, to limit the set of Deployments to those which started before a given moment. Example: 2000-01-01T01:23

Response

Success

string required

Changes

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