Back to Rancher.com
Download Rancher
Request Support
Rancher 1.6 Docs
Rancher Documentation
How to use the API v2-beta
Setting up Access Control using the API
What are API keys
API Resources
Common Resource Fields
Account
Account
Activate
Deactivate
ApiKey
ApiKey
Create
Update
Delete
Activate
Deactivate
AuditLog
AuditLog
Certificate
Certificate
Create
Update
Delete
Container
Container
Create
Update
Delete
Console
Execute
Logs
Proxy
Restart
Start
Stop
DnsService
DnsService
Create
Update
Delete
Activate
Continueupgrade
Deactivate
Removeservicelink
Rollback
Setservicelinks
Upgrade
ExternalService
ExternalService
Create
Update
Delete
Activate
Cancelupgrade
Continueupgrade
Deactivate
Finishupgrade
Rollback
Upgrade
Host
Host
Create
Update
Delete
Activate
Deactivate
Dockersocket
Error
Identity
Identity
LoadBalancerService
LoadBalancerService
Create
Update
Delete
Activate
Addservicelink
Cancelupgrade
Continueupgrade
Deactivate
Finishupgrade
Removeservicelink
Rollback
Setservicelinks
Upgrade
Machine
Machine
Create
Update
Delete
MachineDriver
MachineDriver
Network
Network
Create
Update
Delete
NetworkDriver
NetworkDriver
NetworkDriverService
NetworkDriverService
Create
Update
Delete
Activate
Addservicelink
Cancelupgrade
Continueupgrade
Deactivate
Finishupgrade
Removeservicelink
Restart
Rollback
Setservicelinks
Upgrade
NetworkPolicyRuleWithin
NetworkPolicyRuleWithin
Create
Project
Project
Activate
Deactivate
DefaultNetworkId
Setmembers
Upgrade
ProjectMember
ProjectMember
Activate
Deactivate
ProjectTemplate
ProjectTemplate
PullTask
PullTask
Create
RegistrationToken
RegistrationToken
Create
Registry
Registry
Create
Update
Delete
Activate
Deactivate
RegistryCredential
RegistryCredential
Create
Update
Delete
Activate
Deactivate
Secret
Secret
Create
Update
Delete
Service
Service
Create
Update
Delete
Activate
Addservicelink
Cancelupgrade
Continueupgrade
Deactivate
Finishupgrade
Removeservicelink
Restart
Rollback
Setservicelinks
Upgrade
ServiceLog
ServiceLog
Setting
Setting
Stack
Stack
Create
Update
Delete
Activateservices
Addoutputs
Cancelupgrade
Deactivateservices
Error
Exportconfig
Finishupgrade
Rollback
Upgrade
StorageDriver
StorageDriver
StorageDriverService
StorageDriverService
Create
Update
Delete
Activate
Addservicelink
Cancelupgrade
Continueupgrade
Deactivate
Finishupgrade
Removeservicelink
Restart
Rollback
Setservicelinks
Upgrade
Subscribe
Subscribe
Create
Volume
Volume
Create
Update
Delete
Restorefrombackup
Reverttosnapshot
Snapshot
VolumeTemplate
VolumeTemplate
Create
These docs are for Rancher 1.6, if you are looking for Rancher 2.x docs, see
here
.
targetPortRule
Resource Fields
Writeable Fields
Field
Type
Create
Update
Default
Notes
backendName
string
Optional
-
-
hostname
string
Optional
-
-
path
string
Optional
-
-
targetPort
int
Yes
-
-
Edit this page