Back to Rancher.com
Download Rancher
Request Support
Rancher 1.6 Docs
Rancher Documentation
How to use the API v1
Setting up Access Control using the API
What are API keys
API Resources
Common Resource Fields
Account
Account
Create
Update
Delete
Activate
Deactivate
Agent
Agent
Activate
Deactivate
Disconnect
Reconnect
ApiKey
ApiKey
Create
Update
Delete
Activate
Deactivate
AuditLog
AuditLog
Azureadconfig
Azureadconfig
Create
Update
Certificate
Certificate
ConfigItem
ConfigItem
ConfigItemStatus
ConfigItemStatus
Update
Container
Container
Console
Execute
Logs
Proxy
Restart
Start
Stop
Databasechangelog
Databasechangelog
Delete
Databasechangeloglock
Databasechangeloglock
Delete
DnsService
DnsService
Activate
Deactivate
Removeservicelink
Rollback
Setservicelinks
Upgrade
Environment
Environment
Activateservices
Cancelrollback
Cancelupgrade
Deactivateservices
Exportconfig
Finishupgrade
Rollback
ExtensionPoint
ExtensionPoint
ExternalHandler
ExternalHandler
Create
Update
Activate
Deactivate
ExternalHandlerExternalHandlerProcessMap
ExternalHandlerExternalHandlerProcessMap
Activate
Deactivate
ExternalHandlerProcess
ExternalHandlerProcess
Activate
Deactivate
ExternalService
ExternalService
Activate
Cancelrollback
Cancelupgrade
Deactivate
Finishupgrade
Rollback
Upgrade
Githubconfig
Githubconfig
Create
Update
HaConfig
HaConfig
Update
Createscript
HaConfigInput
HaConfigInput
Create
Host
Host
Activate
Deactivate
Dockersocket
HostApiProxyToken
HostApiProxyToken
Identity
Identity
Ldapconfig
Ldapconfig
Create
Update
LoadBalancerService
LoadBalancerService
Activate
Addservicelink
Cancelrollback
Cancelupgrade
Deactivate
Finishupgrade
Removeservicelink
Rollback
Setservicelinks
Upgrade
LocalAuthConfig
LocalAuthConfig
Create
Machine
Machine
MachineDriver
MachineDriver
Create
Update
Delete
Activate
Deactivate
Reactivate
Network
Network
Openldapconfig
Openldapconfig
Create
Update
ProcessDefinition
ProcessDefinition
ProcessExecution
ProcessExecution
ProcessInstance
ProcessInstance
Project
Project
Create
Update
Delete
Activate
Deactivate
Setmembers
ProjectMember
ProjectMember
Create
Activate
Deactivate
PullTask
PullTask
RegistrationToken
RegistrationToken
Registry
Registry
Activate
Deactivate
RegistryCredential
RegistryCredential
Activate
Deactivate
ResourceDefinition
ResourceDefinition
Service
Service
Activate
Addservicelink
Cancelrollback
Cancelupgrade
Deactivate
Finishupgrade
Removeservicelink
Restart
Rollback
Setservicelinks
Upgrade
Setting
Setting
Create
Update
Delete
Task
Task
Execute
TaskInstance
TaskInstance
UserPreference
UserPreference
Create
Update
Delete
Activate
Deactivate
Volume
Volume
Restorefrombackup
Reverttosnapshot
Snapshot
These docs are for Rancher 1.6, if you are looking for Rancher 2.x docs, see
here
.
serviceUpgrade
Resource Fields
Writeable Fields
Field
Type
Create
Update
Default
Notes
inServiceStrategy
inServiceUpgradeStrategy
Optional
-
-
toServiceStrategy
toServiceUpgradeStrategy
Optional
-
-
Edit this page