Octopus deploy api

Example :

var octopusapi = require('octopusapi'); 

var client = new octopusapi('http{s}://youroctopusserver.domain:port}','yourApiKey')

client.Projects((err,body)=>{
  console.log(err);
  console.log(body);
})

Api definitions:

Functions

Typedefs

octopusapi(actopusurl, apikey)

octopus - description

Kind: global function

| Param | Type | Description | | --- | --- | --- | | actopusurl | string | octopus-deploy-url | | apikey | string | apikey |

• octopusapi(actopusurl, apikey)
  • .Self(callback)
  • .Accounts(id, params, callback)
  • .ActionTemplates(id, params, callback)
  • .Alerts(id, params, callback)
  • .Artifacts(id, params, callback)
  • .Channels(id, callback)
  • .Certificates(id, params, callback)
  • .CurrentUser(callback)
  • .CurrentLicense(callback)
  • .Dashboard(callback)
  • .DashboardConfiguration(callback)
  • .DashboardDynamic(params, callback)
  • .DeploymentProcesses(id, callback)
  • .Deployments(id, params, callback)
  • .DiscoverMachine(params, callback)
  • .Environments(id, params, callback)
  • .EnvironmentSortOrder(callback)
  • .Events(id, params, callback)
  • .ExternalSecurityGroups(id, params, callback)
  • .Feeds(id, params, callback)
  • .Interruptions(id, params, callback)
  • .Invitations(callback)
  • .LibraryVariables(id, params, callback)
  • .Lifecycles(id, params, callback)
  • .MachineRoles(callback)
  • .Machines(id, params, callback)
  • .MaintenanceConfiguration(callback)
  • .OctopusServerNodes(id, callback)
  • .Packages(id, params, callback)
  • .PackagesBulk(params, callback)
  • .PackageUpload(params, callback)
  • .ProjectGroups(id, params, callback)
  • .Projects(id, params, callback)
  • .ProjectPulse(params, callback)
  • .Register(callback)
  • .Releases(id, params, callback)
  • .ServerStatus(callback)
  • .SignIn(params, callback)
  • .SignOut(callback)
  • .RetentionPolicies(id, params, callback)
  • .SmtpConfiguration(callback)
  • .Tasks(id, params, callback)
  • .Teams(id, params, callback)
  • .UserRoles(id, params, callback)
  • .Users(id, params, callback)
  • .PermissionDescriptions(callback)
  • .Variables(id, callback)
  • .VariableNames(params, callback)
  • .VariablesNonPrintableChars(callback)
  • .VersionRuleTest(params, callback)
  • .ReportingDeploymentsCountedByWeek(params, callback)
  • .RepositoryConfiguration(callback)
  • .Web(callback)

octopusapi.Self(callback)

octopusapi.prototype.Self - Self

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.Accounts(id, params, callback)

octopusapi.prototype.Accounts - Accounts

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip} | | callback | callback | A callback to run. |

octopusapi.ActionTemplates(id, params, callback)

octopusapi.prototype.ActionTemplates - ActionTemplates

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip} | | callback | callback | A callback to run. |

octopusapi.Alerts(id, params, callback)

octopusapi.prototype.Alerts - Alerts

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip} | | callback | callback | A callback to run. |

octopusapi.Artifacts(id, params, callback)

octopusapi.prototype.Artifacts - Artifacts

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip,regarding} | | callback | callback | A callback to run. |

octopusapi.Channels(id, callback)

octopusapi.prototype.Channels - Channels

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | callback | callback | A callback to run. |

octopusapi.Certificates(id, params, callback)

octopusapi.prototype.Certificates - Certificates

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip} | | callback | callback | A callback to run. |

octopusapi.CurrentUser(callback)

octopusapi.prototype.CurrentUser - CurrentUser

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.CurrentLicense(callback)

octopusapi.prototype.CurrentLicense - CurrentLicense

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.Dashboard(callback)

octopusapi.prototype.Dashboard - Dashboard

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.DashboardConfiguration(callback)

octopusapi.prototype.DashboardConfiguration - DashboardConfiguration

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.DashboardDynamic(params, callback)

octopusapi.prototype.DashboardDynamic - DashboardDynamic

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | params | object | extra params {projects,environments,includePrevious} | | callback | callback | A callback to run. |

octopusapi.DeploymentProcesses(id, callback)

octopusapi.prototype.DeploymentProcesses - DeploymentProcesses

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | callback | callback | A callback to run. |

octopusapi.Deployments(id, params, callback)

octopusapi.prototype.Deployments - Deployments

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip,take,projects,environments,taskState} | | callback | callback | A callback to run. |

octopusapi.DiscoverMachine(params, callback)

octopusapi.prototype.DiscoverMachine - DiscoverMachine

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | params | object | extra params {host,port,type} | | callback | callback | A callback to run. |

octopusapi.Environments(id, params, callback)

octopusapi.prototype.Environments - Environments

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip} | | callback | callback | A callback to run. |

octopusapi.EnvironmentSortOrder(callback)

octopusapi.prototype.EnvironmentSortOrder - EnvironmentSortOrder

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.Events(id, params, callback)

octopusapi.prototype.Events - Events

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip,regarding,modifier,user,from,to} | | callback | callback | A callback to run. |

octopusapi.ExternalSecurityGroups(id, params, callback)

octopusapi.prototype.ExternalSecurityGroups - ExternalSecurityGroups

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {name} | | callback | callback | A callback to run. |

octopusapi.Feeds(id, params, callback)

octopusapi.prototype.Feeds - Feeds

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip} | | callback | callback | A callback to run. |

octopusapi.Interruptions(id, params, callback)

octopusapi.prototype.Interruptions - Interruptions

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip,regarding,pendingOnly} | | callback | callback | A callback to run. |

octopusapi.Invitations(callback)

octopusapi.prototype.Invitations - Invitations

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.LibraryVariables(id, params, callback)

octopusapi.prototype.LibraryVariables - LibraryVariables

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip,contentType} | | callback | callback | A callback to run. |

octopusapi.Lifecycles(id, params, callback)

octopusapi.prototype.Lifecycles - Lifecycles

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip} | | callback | callback | A callback to run. |

octopusapi.MachineRoles(callback)

octopusapi.prototype.MachineRoles - MachineRoles

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.Machines(id, params, callback)

octopusapi.prototype.Machines - Machines

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip,thumbprint} | | callback | callback | A callback to run. |

octopusapi.MaintenanceConfiguration(callback)

octopusapi.prototype.MaintenanceConfiguration - MaintenanceConfiguration

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.OctopusServerNodes(id, callback)

octopusapi.prototype.OctopusServerNodes - OctopusServerNodes

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | callback | callback | A callback to run. |

octopusapi.Packages(id, params, callback)

octopusapi.prototype.Packages - Packages

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {nuGetPackageId,filter,latest,skip,take,includeNotes} | | callback | callback | A callback to run. |

octopusapi.PackagesBulk(params, callback)

octopusapi.prototype.PackagesBulk - PackagesBulk

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | params | object | extra params {ids} | | callback | callback | A callback to run. |

octopusapi.PackageUpload(params, callback)

octopusapi.prototype.PackageUpload - PackageUpload

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | params | object | extra params {replace} | | callback | callback | A callback to run. |

octopusapi.ProjectGroups(id, params, callback)

octopusapi.prototype.ProjectGroups - ProjectGroups

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip} | | callback | callback | A callback to run. |

octopusapi.Projects(id, params, callback)

octopusapi.prototype.Projects - Projects

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip,clone} | | callback | callback | A callback to run. |

octopusapi.ProjectPulse(params, callback)

octopusapi.prototype.ProjectPulse - ProjectPulse

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | params | object | extra params {projectIds} | | callback | callback | A callback to run. |

octopusapi.Register(callback)

octopusapi.prototype.Register - Register

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.Releases(id, params, callback)

octopusapi.prototype.Releases - Releases

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip,ignoreChannelRules} | | callback | callback | A callback to run. |

octopusapi.ServerStatus(callback)

octopusapi.prototype.ServerStatus - ServerStatus

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.SignIn(params, callback)

octopusapi.prototype.SignIn - SignIn

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | params | object | extra params {returnUrl} | | callback | callback | A callback to run. |

octopusapi.SignOut(callback)

octopusapi.prototype.SignOut - SignOut

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.RetentionPolicies(id, params, callback)

octopusapi.prototype.RetentionPolicies - RetentionPolicies

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip} | | callback | callback | A callback to run. |

octopusapi.SmtpConfiguration(callback)

octopusapi.prototype.SmtpConfiguration - SmtpConfiguration

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.Tasks(id, params, callback)

octopusapi.prototype.Tasks - Tasks

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip,active,environment,project,name,node,running} | | callback | callback | A callback to run. |

octopusapi.Teams(id, params, callback)

octopusapi.prototype.Teams - Teams

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip} | | callback | callback | A callback to run. |

octopusapi.UserRoles(id, params, callback)

octopusapi.prototype.UserRoles - UserRoles

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip} | | callback | callback | A callback to run. |

octopusapi.Users(id, params, callback)

octopusapi.prototype.Users - Users

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | params | object | extra params {skip} | | callback | callback | A callback to run. |

octopusapi.PermissionDescriptions(callback)

octopusapi.prototype.PermissionDescriptions - PermissionDescriptions

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.Variables(id, callback)

octopusapi.prototype.Variables - Variables

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | id | string | id | | callback | callback | A callback to run. |

octopusapi.VariableNames(params, callback)

octopusapi.prototype.VariableNames - VariableNames

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | params | object | extra params {project} | | callback | callback | A callback to run. |

octopusapi.VariablesNonPrintableChars(callback)

octopusapi.prototype.VariablesNonPrintableChars - VariablesNonPrintableChars

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.VersionRuleTest(params, callback)

octopusapi.prototype.VersionRuleTest - VersionRuleTest

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | params | object | extra params {version,versionRange,preReleaseTag} | | callback | callback | A callback to run. |

octopusapi.ReportingDeploymentsCountedByWeek(params, callback)

octopusapi.prototype.ReportingDeploymentsCountedByWeek - ReportingDeploymentsCountedByWeek

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | params | object | extra params {projectIds} | | callback | callback | A callback to run. |

octopusapi.RepositoryConfiguration(callback)

octopusapi.prototype.RepositoryConfiguration - RepositoryConfiguration

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

octopusapi.Web(callback)

octopusapi.prototype.Web - Web

Kind: instance method of octopusapi

| Param | Type | Description | | --- | --- | --- | | callback | callback | A callback to run. |

callback : function

Callback for request.

Kind: global typedef

| Param | Type | Description | | --- | --- | --- | | err | object | An object. | | body | object | An object. |