Home

Octopus (version v2.*.*)

create_channel_in_project#

Create a ChannelResource

Parameters

baseSpaceId (required)#

ID of the space

Type: string

projectId (required)#

The Project ID to get the channel from. Example Projects-1

Type: string

$body#

The Channel resource to create

Type: object

{
  "IsDefault" : "boolean",
  "LastModifiedBy" : "string",
  "Description" : "string",
  "ProjectId" : "string",
  "SpaceId" : "string",
  "LastModifiedOn" : "date-time",
  "LifecycleId" : "string",
  "Rules" : [ {
    "ActionPackages" : [ {
      "DeploymentAction" : "string",
      "PackageReference" : "string"
    } ],
    "LastModifiedBy" : "string",
    "LastModifiedOn" : "date-time",
    "Links" : "object",
    "VersionRange" : "string",
    "Id" : "string",
    "Tag" : "string",
    "<string>" : { }
  } ],
  "Name" : "string",
  "TenantTags" : [ "string" ],
  "ChangeDescription" : "string",
  "Links" : "object",
  "Id" : "string"
}

create_deployment#

Creates a deployment.

Parameters

baseSpaceId (required)#

ID of the space

Type: string

$body#

Type: object

{
  "DeployedById" : "string",
  "LastModifiedBy" : "string",
  "TaskId" : "string",
  "DeployedToMachineIds" : [ "string" ],
  "LastModifiedOn" : "date-time",
  "ChannelId" : "string",
  "Created" : "date-time",
  "Name" : "string",
  "EnvironmentId" : "Required string",
  "ExcludedMachineIds" : [ "string" ],
  "TentacleRetentionPeriod" : {
    "QuantityToKeep" : "integer",
    "Unit" : "string. Possible values: Days | Items",
    "ShouldKeepForever" : "boolean"
  },
  "QueueTime" : "date-time",
  "Changes" : [ {
    "Commits" : [ {
      "Comment" : "string",
      "LinkUrl" : "string",
      "Id" : "string"
    } ],
    "WorkItems" : [ {
      "Description" : "string",
      "LinkUrl" : "string",
      "Id" : "string",
      "Source" : "string"
    } ],
    "Version" : "string",
    "BuildInformation" : [ {
      "Commits" : [ {
        "Comment" : "string",
        "LinkUrl" : "string",
        "Id" : "string"
      } ],
      "BuildNumber" : "string",
      "WorkItems" : [ {
        "Description" : "string",
        "LinkUrl" : "string",
        "Id" : "string",
        "Source" : "string"
      } ],
      "VcsCommitNumber" : "string",
      "VcsType" : "string",
      "BuildEnvironment" : "string",
      "BuildUrl" : "string",
      "Version" : "string",
      "Branch" : "string",
      "PackageId" : "string",
      "VcsRoot" : "string",
      "VcsCommitUrl" : "string"
    } ],
    "ReleaseNotes" : "string"
  } ],
  "ManifestVariableSetId" : "string",
  "ForcePackageRedeployment" : "boolean",
  "QueueTimeExpiry" : "date-time",
  "Comments" : "string",
  "ForcePackageDownload" : "boolean",
  "ProjectId" : "string",
  "SpaceId" : "string",
  "SpecificMachineIds" : [ "string" ],
  "ReleaseId" : "Required string",
  "TenantId" : "string",
  "DeployedBy" : "string",
  "UseGuidedFailure" : "boolean",
  "FailureEncountered" : "boolean",
  "SkipActions" : [ "string" ],
  "Links" : "object",
  "DeploymentProcessId" : "string",
  "Id" : "string",
  "ChangesMarkdown" : "string",
  "FormValues" : "object"
}

delete_deployment#

Deletes an existing deployment.

Parameters

baseSpaceId (required)#

ID of the space

Type: string

id (required)#

ID of the Deployment to delete

Type: string

delete_environment#

Deletes an existing environment.

Parameters

baseSpaceId (required)#

ID of the space

Type: string

id (required)#

ID of the Environment to delete

Type: string

delete_release#

Deletes an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.

Parameters

baseSpaceId (required)#

ID of the space

Type: string

id (required)#

Id of the Release to delete

Type: string

delete_space#

Deletes an existing Space.

Parameters

id (required)#

Id of the Space to be deleted

Type: string

get_dashboard#

Returns information required to render the Octopus dashboard

Parameters

baseSpaceId (required)#

ID of the space

Type: string

get_deployment#

Get a Deployment by ID

Parameters

baseSpaceId (required)#

ID of the space

Type: string

id (required)#

ID of the Deployment to load

Type: string

get_environment#

Gets a single environment by ID.

Parameters

baseSpaceId (required)#

ID of the space

Type: string

id (required)#

ID of the Environmen to load

Type: string

get_project#

Gets a single project by ID or Slug.

Parameters

baseSpaceId (required)#

ID of the space

Type: string

id (required)#

ID of the Project to load

Type: string

get_release#

Get a Release by ID

Parameters

baseSpaceId (required)#

ID of the space

Type: string

id (required)#

ID of the Release to load

Type: string

get_space#

Get a SpaceResource by ID

Parameters

id (required)#

ID of the SpaceResource to load

Type: string

list_channels_for_project#

Get a list of ChannelResources for the given ProjectResource

Parameters

baseSpaceId (required)#

ID of the space

Type: string

projectId (required)#

ID of the Project

Type: string

partialName#

A partial or complete name to limit the set of retrieved Tenants to. This will perform a "contains" style match against the supplied name or name-fragment

Type: string

list_deployments#

Lists all of the Deployments in the supplied Space. The results will be sorted from most recent to least recent deployment.

Parameters

baseSpaceId (required)#

ID of the space

Type: string

channels#

Channel Ids to filter results to only Deployments with the given Channel Ids

Type: array

[ "string" ]

environments#

Environment Ids to filter results to only Deployments with the given Environment Ids

Type: array

[ "string" ]

ids#

Deployment Ids to filter results to only Deployments with the given Ids

Type: array

[ "string" ]

partialName#

A partial name, to limit the set of Deployments to those with a name that includes the partial name

Type: string

projects#

Project Ids to filter results to only Deployments with the given Project Ids

Type: array

[ "string" ]

taskState#

Task State to filter results to only Deployments with the given Task State

Type: string

tenants#

Tenant Ids to filter results to only Deployments with the given Tenant Ids

Type: array

[ "string" ]

list_environments#

Lists the name and ID of all of the environments in the supplied Octopus Deploy Space. The results will be sorted by the SortOrder field on each environment.

Parameters

baseSpaceId (required)#

ID of the space

Type: string

channelId#

A Channel Id used to filter a query.

Type: string

ids#

A comma separated list of Deployment Environment resource ids used to filter a query.

Type: array

[ "string" ]

projectId#

A project Id used to filter a query.

Type: string

list_projects#

Lists the name and ID of all of the projects in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.

Parameters

baseSpaceId (required)#

ID of the space

Type: string

list_releases_by_channel#

Lists all of the releases that belong to the given Channel. Releases will be ordered from most recent to least recent.

Parameters

baseSpaceId (required)#

ID of the space

Type: string

id (required)#

ID of the Channel to get Releases for.

Type: string

projectId (required)#

Type: string

searchByVersion#

A partial version, to limit the set of Releases to those with a version that includes the partial version

Type: string

list_releases_in_project#

Lists all of the releases that belong to the given Project. Releases will be ordered from most recent to least recent.

Parameters

baseSpaceId (required)#

ID of the space

Type: string

projectId (required)#

ID of the Project to get Releases for.

Type: string

searchByVersion#

A partial version, to limit the set of Releases to those with a version that includes the partial version

Type: string

list_spaces#

Lists all Spaces. The results will be sorted alphabetically by name.

Parameters

partialName#

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

Type: string

list_variables#

Lists all the Variable Sets in the supplied Space.

Parameters

baseSpaceId (required)#

ID of the space

Type: string

ids#

A comma separated list of Variable Set resource ids used to filter a query.

Type: array

[ "string" ]

update_environment#

Modifies an existing environment.

Parameters

baseSpaceId (required)#

ID of the space

Type: string

id (required)#

ID of the EnvironmentResource to modify

Type: string

$body#

The EnvironmentResource resource to create

Type: object

{
  "LastModifiedBy" : "string",
  "AllowDynamicInfrastructure" : "boolean",
  "Description" : "string",
  "UseGuidedFailure" : "boolean",
  "SpaceId" : "string",
  "LastModifiedOn" : "date-time",
  "Links" : "object",
  "SortOrder" : "integer",
  "ExtensionSettings" : [ {
    "Values" : { },
    "ExtensionId" : "string"
  } ],
  "Id" : "string",
  "Name" : "string"
}

update_release#

Updates an existing Release

Parameters

baseSpaceId (required)#

ID of the space

Type: string

id (required)#

ID of the Release

Type: string

$body#

The desired state of the Release

Type: object

{
  "LastModifiedBy" : "string",
  "VersionControlReference" : {
    "GitCommit" : "string",
    "GitRef" : "string"
  },
  "ProjectDeploymentProcessSnapshotId" : "string",
  "ProjectId" : "string",
  "SpaceId" : "string",
  "Assembled" : "date-time",
  "LastModifiedOn" : "date-time",
  "SelectedPackages" : [ {
    "ActionName" : "string",
    "PackageReferenceName" : "string",
    "Version" : "string",
    "StepName" : "string"
  } ],
  "ChannelId" : "string",
  "ReleaseNotes" : "string",
  "LibraryVariableSetSnapshotIds" : [ "string" ],
  "IgnoreChannelRules" : "boolean",
  "Version" : "Required string",
  "ProjectVariableSetSnapshotId" : "string",
  "Links" : "object",
  "BuildInformation" : [ {
    "Commits" : [ {
      "Comment" : "string",
      "LinkUrl" : "string",
      "Id" : "string"
    } ],
    "VcsType" : "string",
    "IssueTrackerName" : "string",
    "VcsRoot" : "string",
    "BuildNumber" : "string",
    "WorkItems" : [ {
      "Description" : "string",
      "LinkUrl" : "string",
      "Id" : "string",
      "Source" : "string"
    } ],
    "VcsCommitNumber" : "string",
    "BuildEnvironment" : "string",
    "BuildUrl" : "string",
    "Version" : "string",
    "Branch" : "string",
    "PackageId" : "string",
    "VcsCommitUrl" : "string"
  } ],
  "Id" : "string"
}

ignoreChannelRules#

Ignore channel rules.

Type: boolean

update_space#

Modifies an existing space.

Parameters

id (required)#

ID of the resource

Type: string