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
Activate
Deactivate
AddOutputsInput
AddOutputsInput
Amazonec2Config
Amazonec2Config
Create
ApiKey
ApiKey
Create
Update
Delete
Activate
Deactivate
AuditLog
AuditLog
AzureConfig
AzureConfig
Create
Certificate
Certificate
Create
Update
Delete
Container
Container
Create
Update
Delete
Console
Execute
Logs
Proxy
Restart
Start
Stop
ContainerExec
ContainerExec
Create
DigitaloceanConfig
DigitaloceanConfig
Create
DnsService
DnsService
Create
Update
Delete
Activate
Deactivate
Removeservicelink
Rollback
Setservicelinks
Upgrade
DockerBuild
DockerBuild
Create
Environment
Environment
Create
Update
Delete
Activateservices
Cancelrollback
Cancelupgrade
Deactivateservices
Exportconfig
Finishupgrade
Rollback
EnvironmentUpgrade
EnvironmentUpgrade
Create
ExoscaleConfig
ExoscaleConfig
Create
ExternalService
ExternalService
Create
Update
Delete
Activate
Cancelrollback
Cancelupgrade
Deactivate
Finishupgrade
Rollback
Upgrade
GenericConfig
GenericConfig
Create
GoogleConfig
GoogleConfig
Create
Host
Host
Update
Delete
Activate
Deactivate
Dockersocket
HostAccess
HostAccess
HypervConfig
HypervConfig
Create
Identity
Identity
LoadBalancerConfig
LoadBalancerConfig
Create
Update
Delete
LoadBalancerService
LoadBalancerService
Create
Update
Delete
Activate
Addservicelink
Cancelrollback
Cancelupgrade
Deactivate
Finishupgrade
Removeservicelink
Rollback
Setservicelinks
Upgrade
Machine
Machine
Create
Delete
Network
Network
OpenstackConfig
OpenstackConfig
Create
PacketConfig
PacketConfig
Create
Project
Project
Activate
Deactivate
Setmembers
ProjectMember
ProjectMember
Activate
Deactivate
PullTask
PullTask
Create
RackspaceConfig
RackspaceConfig
Create
RegistrationToken
RegistrationToken
Create
Registry
Registry
Create
Update
Delete
Activate
Deactivate
RegistryCredential
RegistryCredential
Create
Update
Delete
Activate
Deactivate
Service
Service
Create
Update
Delete
Activate
Addservicelink
Cancelrollback
Cancelupgrade
Deactivate
Finishupgrade
Removeservicelink
Restart
Rollback
Setservicelinks
Upgrade
Setting
Setting
SoftlayerConfig
SoftlayerConfig
Create
StatsAccess
StatsAccess
Subscribe
Subscribe
Create
UbiquityConfig
UbiquityConfig
Create
VirtualboxConfig
VirtualboxConfig
Create
VmwarefusionConfig
VmwarefusionConfig
Create
VmwarevcloudairConfig
VmwarevcloudairConfig
Create
VmwarevsphereConfig
VmwarevsphereConfig
Create
Volume
Volume
Create
Delete
These docs are for Rancher 1.6, if you are looking for Rancher 2.x docs, see
here
.
haproxyConfig
Resource Fields
Writeable Fields
Field
Type
Create
Update
Default
Notes
defaults
string
Optional
Yes
-
global
string
Optional
Yes
-
Edit this page