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
- 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
GenericObject
- GenericObject
- Create
- Delete
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
Project
- Project
- Activate
- Deactivate
- 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
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
Subnet
- Subnet
Subscribe
- Subscribe
- Create
Volume
- Volume
- Create
- Update
- Delete
- Restorefrombackup
- Reverttosnapshot
- Snapshot
VolumeTemplate
- VolumeTemplate
- Create

publicEndpoint

Resource Fields

Read Only Fields

Field	Type	Notes
hostId	host	The unique identifier for the associated host
instanceId	instance	The unique identifier for the associated instance
ipAddress	string
port	int
serviceId	service	The unique identifier of the associated service