Rancher API: API

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
- Create
- Update
- Delete
- Activate
- Deactivate
Agent
- Agent
- Activate
- Deactivate
- Disconnect
- Finishreconnect
- Reconnect
ApiKey
- ApiKey
- Create
- Update
- Delete
- Activate
- Deactivate
AuditLog
- AuditLog
Azureadconfig
- Azureadconfig
- Create
- Update
Certificate
- Certificate
ClusterMembership
- ClusterMembership
ConfigItem
- ConfigItem
ConfigItemStatus
- ConfigItemStatus
- Update
Container
- Container
- Console
- Execute
- Logs
- Proxy
- Restart
- Start
- Stop
Databasechangelog
- Databasechangelog
- Delete
Databasechangeloglock
- Databasechangeloglock
- Delete
DnsService
- DnsService
- Activate
- Continueupgrade
- Deactivate
- Removeservicelink
- Rollback
- Setservicelinks
- Upgrade
ExtensionPoint
- ExtensionPoint
ExternalHandler
- ExternalHandler
- Create
- Update
- Activate
- Deactivate
ExternalHandlerExternalHandlerProcessMap
- ExternalHandlerExternalHandlerProcessMap
- Activate
- Deactivate
ExternalHandlerProcess
- ExternalHandlerProcess
- Activate
- Deactivate
ExternalService
- ExternalService
- Activate
- Cancelupgrade
- Continueupgrade
- Deactivate
- Finishupgrade
- Rollback
- Upgrade
HaConfig
- HaConfig
- Update
- Createscript
HaConfigInput
- HaConfigInput
- Create
Host
- Host
- Activate
- Deactivate
- Dockersocket
- Error
- Evacuate
HostApiProxyToken
- HostApiProxyToken
HostTemplate
- HostTemplate
Identity
- Identity
Ldapconfig
- Ldapconfig
- Create
- Update
LoadBalancerService
- LoadBalancerService
- Activate
- Addservicelink
- Cancelupgrade
- Continueupgrade
- Deactivate
- Finishupgrade
- Removeservicelink
- Rollback
- Setservicelinks
- Upgrade
LocalAuthConfig
- LocalAuthConfig
- Create
Machine
- Machine
MachineDriver
- MachineDriver
- Create
- Update
- Delete
- Activate
- Deactivate
- Reactivate
Network
- Network
NetworkDriver
- NetworkDriver
NetworkDriverService
- NetworkDriverService
- Activate
- Addservicelink
- Cancelupgrade
- Continueupgrade
- Deactivate
- Finishupgrade
- Removeservicelink
- Restart
- Rollback
- Setservicelinks
- Upgrade
NetworkPolicyRuleWithin
- NetworkPolicyRuleWithin
- Create
Openldapconfig
- Openldapconfig
- Create
- Update
ProcessDefinition
- ProcessDefinition
ProcessExecution
- ProcessExecution
ProcessInstance
- ProcessInstance
- Replay
ProcessPool
- ProcessPool
ProcessSummary
- ProcessSummary
Project
- Project
- Create
- Update
- Delete
- Activate
- Deactivate
- DefaultNetworkId
- Setmembers
- Upgrade
ProjectMember
- ProjectMember
- Create
- Activate
- Deactivate
ProjectTemplate
- ProjectTemplate
- Create
- Update
- Delete
PullTask
- PullTask
RegistrationToken
- RegistrationToken
Registry
- Registry
- Activate
- Deactivate
RegistryCredential
- RegistryCredential
- Activate
- Deactivate
ResourceDefinition
- ResourceDefinition
ScheduledUpgrade
- ScheduledUpgrade
- Start
Secret
- Secret
Service
- Service
- Activate
- Addservicelink
- Cancelupgrade
- Continueupgrade
- Deactivate
- Finishupgrade
- Removeservicelink
- Restart
- Rollback
- Setservicelinks
- Upgrade
ServiceLog
- ServiceLog
Setting
- Setting
- Create
- Update
- Delete
Stack
- Stack
- Activateservices
- Addoutputs
- Cancelupgrade
- Deactivateservices
- Error
- Exportconfig
- Finishupgrade
- Rollback
- Upgrade
StorageDriver
- StorageDriver
StorageDriverService
- StorageDriverService
- Activate
- Addservicelink
- Cancelupgrade
- Continueupgrade
- Deactivate
- Finishupgrade
- Removeservicelink
- Restart
- Rollback
- Setservicelinks
- Upgrade
Task
- Task
- Execute
TaskInstance
- TaskInstance
UserPreference
- UserPreference
- Create
- Update
- Delete
- Activate
- Deactivate
Volume
- Volume
- Restorefrombackup
- Reverttosnapshot
- Snapshot
VolumeTemplate
- VolumeTemplate

lbTargetConfig

Resource Fields

Writeable Fields

Field	Type	Create	Update	Default	Notes
portRules	array[targetPortRule]	Optional	Yes	-