ActionTemplates

Get usages for an Action Template.

Gets a list of all steps/deployment processes that use a given action template.

get/{spaceId}/actiontemplates/{id}/usage

Request

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

idstring required

ID of the resource

Query parameters

branchstring

Optionally filter usages associated with a config as code branch

process'Deployment' | 'Runbook'

Optionally filter by process type

projectstring

Optionally filter version controlled usages by project

withUpdatesboolean

Optionally filter for only version controlled usages with updates

Response

The requested Action Template usages

ActionIdstring required
ActionNamestring required
ActionTemplateIdstring required
Branchstring
DeploymentProcessIdstring
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.

ProcessIdstring required
ProcessType'Deployment' | 'Runbook'
ProjectIdstring required
ProjectNamestring required
ProjectSlugstring required
Releasestring
RunbookIdstring
RunbookNamestring
StepIdstring required
StepNamestring required
Versionstring

Example response

[
  {
    "Links": {
      "Self": "/api/..."
    }
  }
]

Changes

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