Preparing search index...
The search index is not available
@octopusdeploy/api-client
@octopusdeploy/api-client
apiLocation
Variable apiLocation
Const
api
Location
:
string
= "~/api"
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
@octopusdeploy/api-
client
Activity
Log
Entry
Category
Activity
Status
Authentication
Type
Connectivity
Check
Response
Message
Category
Control
Type
Guided
Failure
Mode
Identity
Type
Overwrite
Mode
Package
Acquisition
Location
Package
Requirement
Package
Selection
Mode
Permission
Persistence
Settings
Type
Property
Applicability
Mode
Retention
Unit
Run
Condition
Run
Condition
For
Action
Runbook
Environment
Scope
Start
Trigger
Task
State
Tenanted
Deployment
Mode
Basic
Repository
Build
Information
Repository
Client
Deployment
Process
Repository
Deployment
Repository
Environment
Repository
Lifecycle
Repository
Nu
Get
Package
Builder
Package
Identity
Package
Repository
Project
Group
Repository
Project
Repository
Release
Repository
Resolver
Runbook
Process
Repository
Runbook
Repository
Runbook
Run
Repository
Runbook
Snapshot
Repository
Server
Task
Waiter
Space
Repository
Space
Scoped
Basic
Repository
Space
Server
Task
Repository
Subscription
Record
Tag
Set
Repository
Tenant
Repository
Zip
Package
Builder
Action
Template
Parameter
Action
Template
Parameter
Display
Settings
Active
Directory
Identity
Activity
Element
Activity
Log
Element
Anonymous
Vcs
Credentials
Claims
Based
Identity
Client
Configuration
Client
Error
Response
Details
Client
Options
Client
Request
Details
Client
Response
Details
Commit
Detail
Connectivity
Check
Connectivity
Check
Response
Connectivity
Check
Response
Message
Connectivity
Policy
Convert
Project
To
Version
Controlled
Response
Create
Deployment
Tenanted
Command
V1
Create
Deployment
Tenanted
Response
V1
Create
Deployment
Untenanted
Command
V1
Create
Deployment
Untenanted
Response
V1
Create
Execution
Base
V1
Create
Octopus
Build
Information
Command
Create
Release
Command
V1
Create
Release
Response
V1
Create
Runbook
Run
Command
V1
Create
Runbook
Run
Request
Create
Runbook
Run
Response
V1
Deployment
Deployment
Action
Deployment
Action
Container
Deployment
Action
Package
Deployment
Environment
Deployment
Process
Ocl
Resource
Deployment
Server
Task
Deployment
Settings
Ocl
Resource
Deployment
Settings
Resource
Deployment
Step
Display
Info
Error
Response
Details
Execution
Extension
Settings
Values
External
Identity
ICan
Be
Version
Controlled
ICommit
Command
IOctopus
Build
Information
Commit
IProcess
IVersion
Control
Reference
Identity
Lifecycle
Logger
Mapped
Octopus
Package
Version
Build
Information
Metadata
Type
Collection
Missing
Variable
Multi
Tenancy
Status
Named
Resource
New
Deployment
Environment
New
Deployment
Step
New
Execution
New
Named
Resource
New
Project
New
Resource
New
Runbook
Snapshot
New
Space
New
Tag
New
Tag
Set
New
Tenant
OAuth
Identity
Package
Package
Reference
Phased
Resource
Project
Project
Group
Project
Settings
Metadata
Project
Summary
Prompted
Variable
Values
Property
Applicability
Property
Metadata
Recently
Viewed
Project
Ids
Release
Changes
Release
Creation
Strategy
Release
Package
Version
Build
Information
Request
Details
Resource
Resource
Collection
Resource
Collection
Links
Response
Details
Retention
Period
Runbook
Runbook
Process
Runbook
Retention
Period
Runbook
Run
Runbook
Run
Server
Task
Runbook
Snapshot
Sensitive
Value
Server
Information
Server
Task
Server
Task
Details
Space
Space
Scoped
Args
Space
Scoped
Operation
Space
Scoped
Request
Space
Scoped
Resource
Tag
Tag
Set
Tag
Test
Result
Task
Progress
Tenant
Tenant
Library
Variable
Tenant
Missing
Variable
Tenant
Project
Variable
Tenant
Variable
Tenant
Variable
Template
Tenant
Variable
Template
Display
Settings
Type
Metadata
User
User
Projection
Username
Password
Vcs
Credentials
Variables
Scoped
To
Environment
Response
Vcs
Branch
Vcs
Ref
Version
Control
Compatibility
Response
Version
Controlled
Persistence
Settings
Versioning
Strategy
Work
Item
Link
Action
Inputs
Action
Properties
Callback
Data
Context
Deployment
Process
Environment
Machines
Args
Environment
Summary
Args
Git
Commit
Git
Ref
Links
Collection
List
Args
Location
Props
Modify
Deployment
Process
Command
Modify
Deployment
Process
Ocl
Command
Modify
Deployment
Settings
Command
Modify
Deployment
Settings
Ocl
Command
Modify
Runbook
Command
Name
Or
Id
Key
New
Runbook
New
Space
Scoped
Resource
Nu
Get
Pack
Args
Nu
Spec
Args
Pack
Args
Package
Reference
Properties
Phase
Project
Or
Summary
Property
Value
Resources
By
Id
Resources
By
Name
Or
Id
Route
Args
Unsubscribe
Zip
Pack
Args
api
Location
space
Scoped
Route
Prefix
Get
Named
Package
References
Get
Primary
Package
Reference
Has
Manual
Intervention
Responsible
Teams
Has
Version
Controlled
Persistence
Settings
Initialise
Primary
Package
Reference
Is
Deploy
Release
Action
Is
Named
Package
Reference
Is
Primary
Package
Reference
Is
Using
Username
Password
Auth
New
Project
New
Sensitive
Value
Package
Reference
Names
Match
Remove
Primary
Package
Reference
Set
Named
Package
Reference
Set
Primary
Package
Reference
deployment
Action
Packages
determine
Server
Endpoint
display
Name
ensure
Prefix
ensure
Suffix
get
Branch
Name
From
Route
Parameter
get
Query
Value
get
Resolver
get
Server
Endpoint
getURISafe
Branch
Name
is
Deployment
Process
is
Property
Defined
And
Not
Null
is
Resource
is
Runbook
Process
is
Sensitive
Value
is
Space
Scoped
Args
is
Space
Scoped
Operation
is
Space
Scoped
Request
is
Space
Scoped
Resource
is
Vcs
Branch
Resource
process
Resource
Permission
resolve
Space
Id
type
Safe
Has
Own
Property
user
Get
Current
Generated using
TypeDoc