API.md

Documentation for API Endpoints

All URIs are relative to https://your_kowabunga_kahuna_server/api/v1

Class	Method	HTTP request
AdapterAPI	DeleteAdapter	Delete /adapter/{adapterId}
AdapterAPI	ListAdapters	Get /adapter
AdapterAPI	ReadAdapter	Get /adapter/{adapterId}
AdapterAPI	UpdateAdapter	Put /adapter/{adapterId}
AgentAPI	CreateAgent	Post /agent
AgentAPI	DeleteAgent	Delete /agent/{agentId}
AgentAPI	ListAgents	Get /agent
AgentAPI	ReadAgent	Get /agent/{agentId}
AgentAPI	SetAgentApiToken	Patch /agent/{agentId}/token
AgentAPI	UpdateAgent	Put /agent/{agentId}
InstanceAPI	DeleteInstance	Delete /instance/{instanceId}
InstanceAPI	ListInstances	Get /instance
InstanceAPI	ReadInstance	Get /instance/{instanceId}
InstanceAPI	ReadInstanceRemoteConnection	Get /instance/{instanceId}/connect
InstanceAPI	ReadInstanceState	Get /instance/{instanceId}/state
InstanceAPI	RebootInstance	Patch /instance/{instanceId}/reboot
InstanceAPI	ResetInstance	Patch /instance/{instanceId}/reset
InstanceAPI	ResumeInstance	Patch /instance/{instanceId}/resume
InstanceAPI	ShutdownInstance	Patch /instance/{instanceId}/shutdown
InstanceAPI	StartInstance	Patch /instance/{instanceId}/start
InstanceAPI	StopInstance	Patch /instance/{instanceId}/stop
InstanceAPI	SuspendInstance	Patch /instance/{instanceId}/suspend
InstanceAPI	UpdateInstance	Put /instance/{instanceId}
KaktusAPI	DeleteKaktus	Delete /kaktus/{kaktusId}
KaktusAPI	ListKaktusInstances	Get /kaktus/{kaktusId}/instances
KaktusAPI	ListKaktuss	Get /kaktus
KaktusAPI	ReadKaktus	Get /kaktus/{kaktusId}
KaktusAPI	ReadKaktusCaps	Get /kaktus/{kaktusId}/caps
KaktusAPI	UpdateKaktus	Put /kaktus/{kaktusId}
KawaiiAPI	CreateKawaiiIpSec	Post /kawaii/{kawaiiId}/ipsec
KawaiiAPI	DeleteKawaii	Delete /kawaii/{kawaiiId}
KawaiiAPI	DeleteKawaiiIpSec	Delete /kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}
KawaiiAPI	ListKawaiiIpSecs	Get /kawaii/{kawaiiId}/ipsec
KawaiiAPI	ListKawaiis	Get /kawaii
KawaiiAPI	ReadKawaii	Get /kawaii/{kawaiiId}
KawaiiAPI	ReadKawaiiIpSec	Get /kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}
KawaiiAPI	UpdateKawaii	Put /kawaii/{kawaiiId}
KawaiiAPI	UpdateKawaiiIpSec	Put /kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}
KiwiAPI	DeleteKiwi	Delete /kiwi/{kiwiId}
KiwiAPI	ListKiwis	Get /kiwi
KiwiAPI	ReadKiwi	Get /kiwi/{kiwiId}
KiwiAPI	UpdateKiwi	Put /kiwi/{kiwiId}
KomputeAPI	DeleteKompute	Delete /kompute/{komputeId}
KomputeAPI	ListKomputes	Get /kompute
KomputeAPI	ReadKompute	Get /kompute/{komputeId}
KomputeAPI	ReadKomputeState	Get /kompute/{komputeId}/state
KomputeAPI	RebootKompute	Patch /kompute/{komputeId}/reboot
KomputeAPI	ResetKompute	Patch /kompute/{komputeId}/reset
KomputeAPI	ResumeKompute	Patch /kompute/{komputeId}/resume
KomputeAPI	ShutdownKompute	Patch /kompute/{komputeId}/shutdown
KomputeAPI	StartKompute	Patch /kompute/{komputeId}/start
KomputeAPI	StopKompute	Patch /kompute/{komputeId}/stop
KomputeAPI	SuspendKompute	Patch /kompute/{komputeId}/suspend
KomputeAPI	UpdateKompute	Put /kompute/{komputeId}
KonveyAPI	DeleteKonvey	Delete /konvey/{konveyId}
KonveyAPI	ListKonveys	Get /konvey
KonveyAPI	ReadKonvey	Get /konvey/{konveyId}
KonveyAPI	UpdateKonvey	Put /konvey/{konveyId}
KyloAPI	DeleteKylo	Delete /kylo/{kyloId}
KyloAPI	ListKylos	Get /kylo
KyloAPI	ReadKylo	Get /kylo/{kyloId}
KyloAPI	UpdateKylo	Put /kylo/{kyloId}
NfsAPI	DeleteStorageNFS	Delete /nfs/{nfsId}
NfsAPI	ListStorageNFSKylos	Get /nfs/{nfsId}/kylo
NfsAPI	ListStorageNFSs	Get /nfs
NfsAPI	ReadStorageNFS	Get /nfs/{nfsId}
NfsAPI	UpdateStorageNFS	Put /nfs/{nfsId}
PoolAPI	CreateTemplate	Post /pool/{poolId}/template
PoolAPI	DeleteStoragePool	Delete /pool/{poolId}
PoolAPI	ListStoragePoolTemplates	Get /pool/{poolId}/templates
PoolAPI	ListStoragePoolVolumes	Get /pool/{poolId}/volumes
PoolAPI	ListStoragePools	Get /pool
PoolAPI	ReadStoragePool	Get /pool/{poolId}
PoolAPI	SetStoragePoolDefaultTemplate	Patch /pool/{poolId}/template/{templateId}/default
PoolAPI	UpdateStoragePool	Put /pool/{poolId}
ProjectAPI	CreateProject	Post /project
ProjectAPI	CreateProjectDnsRecord	Post /project/{projectId}/record
ProjectAPI	CreateProjectRegionKawaii	Post /project/{projectId}/region/{regionId}/kawaii
ProjectAPI	CreateProjectRegionKonvey	Post /project/{projectId}/region/{regionId}/konvey
ProjectAPI	CreateProjectRegionKylo	Post /project/{projectId}/region/{regionId}/kylo
ProjectAPI	CreateProjectRegionVolume	Post /project/{projectId}/region/{regionId}/volume
ProjectAPI	CreateProjectZoneInstance	Post /project/{projectId}/zone/{zoneId}/instance
ProjectAPI	CreateProjectZoneKompute	Post /project/{projectId}/zone/{zoneId}/kompute
ProjectAPI	CreateProjectZoneKonvey	Post /project/{projectId}/zone/{zoneId}/konvey
ProjectAPI	DeleteProject	Delete /project/{projectId}
ProjectAPI	ListProjectDnsRecords	Get /project/{projectId}/records
ProjectAPI	ListProjectRegionKawaiis	Get /project/{projectId}/region/{regionId}/kawaiis
ProjectAPI	ListProjectRegionKonveys	Get /project/{projectId}/region/{regionId}/konveys
ProjectAPI	ListProjectRegionKylos	Get /project/{projectId}/region/{regionId}/kylo
ProjectAPI	ListProjectRegionVolumes	Get /project/{projectId}/region/{regionId}/volumes
ProjectAPI	ListProjectZoneInstances	Get /project/{projectId}/zone/{zoneId}/instances
ProjectAPI	ListProjectZoneKomputes	Get /project/{projectId}/zone/{zoneId}/komputes
ProjectAPI	ListProjectZoneKonveys	Get /project/{projectId}/zone/{zoneId}/konveys
ProjectAPI	ListProjects	Get /project
ProjectAPI	ReadProject	Get /project/{projectId}
ProjectAPI	ReadProjectCost	Get /project/{projectId}/cost
ProjectAPI	ReadProjectUsage	Get /project/{projectId}/usage
ProjectAPI	UpdateProject	Put /project/{projectId}
RecordAPI	DeleteDnsRecord	Delete /record/{recordId}
RecordAPI	ReadDnsRecord	Get /record/{recordId}
RecordAPI	UpdateDnsRecord	Put /record/{recordId}
RegionAPI	CreateKiwi	Post /region/{regionId}/kiwi
RegionAPI	CreateRegion	Post /region
RegionAPI	CreateStorageNFS	Post /region/{regionId}/nfs
RegionAPI	CreateStoragePool	Post /region/{regionId}/pool
RegionAPI	CreateVNet	Post /region/{regionId}/vnet
RegionAPI	CreateZone	Post /region/{regionId}/zone
RegionAPI	DeleteRegion	Delete /region/{regionId}
RegionAPI	ListRegionKiwis	Get /region/{regionId}/kiwis
RegionAPI	ListRegionStorageNFSs	Get /region/{regionId}/nfs
RegionAPI	ListRegionStoragePools	Get /region/{regionId}/pools
RegionAPI	ListRegionVNets	Get /region/{regionId}/vnets
RegionAPI	ListRegionZones	Get /region/{regionId}/zones
RegionAPI	ListRegions	Get /region
RegionAPI	ReadRegion	Get /region/{regionId}
RegionAPI	SetRegionDefaultStorageNFS	Patch /region/{regionId}/nfs/{nfsId}/default
RegionAPI	SetRegionDefaultStoragePool	Patch /region/{regionId}/pool/{poolId}/default
RegionAPI	UpdateRegion	Put /region/{regionId}
SubnetAPI	CreateAdapter	Post /subnet/{subnetId}/adapter
SubnetAPI	DeleteSubnet	Delete /subnet/{subnetId}
SubnetAPI	ListSubnetAdapters	Get /subnet/{subnetId}/adapters
SubnetAPI	ListSubnets	Get /subnet
SubnetAPI	ReadSubnet	Get /subnet/{subnetId}
SubnetAPI	UpdateSubnet	Put /subnet/{subnetId}
TeamAPI	CreateTeam	Post /team
TeamAPI	DeleteTeam	Delete /team/{teamId}
TeamAPI	ListTeams	Get /team
TeamAPI	ReadTeam	Get /team/{teamId}
TeamAPI	UpdateTeam	Put /team/{teamId}
TemplateAPI	DeleteTemplate	Delete /template/{templateId}
TemplateAPI	ListTemplates	Get /template
TemplateAPI	ReadTemplate	Get /template/{templateId}
TemplateAPI	UpdateTemplate	Put /template/{templateId}
TokenAPI	DeleteApiToken	Delete /token/{tokenId}
TokenAPI	ListApiTokens	Get /token
TokenAPI	ReadApiToken	Get /token/{tokenId}
TokenAPI	UpdateApiToken	Put /token/{tokenId}
UserAPI	CreateUser	Post /user
UserAPI	DeleteUser	Delete /user/{userId}
UserAPI	ListUsers	Get /user
UserAPI	Login	Post /login
UserAPI	Logout	Post /logout
UserAPI	ReadUser	Get /user/{userId}
UserAPI	ResetPassword	Put /resetPassword
UserAPI	ResetUserPassword	Patch /user/{userId}/resetPassword
UserAPI	SetUserApiToken	Patch /user/{userId}/token
UserAPI	SetUserPassword	Put /user/{userId}/password
UserAPI	UpdateUser	Put /user/{userId}
VnetAPI	CreateSubnet	Post /vnet/{vnetId}/subnet
VnetAPI	DeleteVNet	Delete /vnet/{vnetId}
VnetAPI	ListVNetSubnets	Get /vnet/{vnetId}/subnets
VnetAPI	ListVNets	Get /vnet
VnetAPI	ReadVNet	Get /vnet/{vnetId}
VnetAPI	SetVNetDefaultSubnet	Patch /vnet/{vnetId}/subnet/{subnetId}/default
VnetAPI	UpdateVNet	Put /vnet/{vnetId}
VolumeAPI	DeleteVolume	Delete /volume/{volumeId}
VolumeAPI	ListVolumes	Get /volume
VolumeAPI	ReadVolume	Get /volume/{volumeId}
VolumeAPI	UpdateVolume	Put /volume/{volumeId}
ZoneAPI	CreateKaktus	Post /zone/{zoneId}/kaktus
ZoneAPI	DeleteZone	Delete /zone/{zoneId}
ZoneAPI	ListZoneKaktuses	Get /zone/{zoneId}/kaktuses
ZoneAPI	ListZones	Get /zone
ZoneAPI	ReadZone	Get /zone/{zoneId}
ZoneAPI	UpdateZone	Put /zone/{zoneId}

Documentation For Models

• Adapter
• Agent
• ApiErrorBadRequest
• ApiErrorConflict
• ApiErrorForbidden
• ApiErrorInsufficientResource
• ApiErrorNotFound
• ApiErrorUnauthorized
• ApiErrorUnprocessableEntity
• ApiToken
• Cost
• DnsRecord
• Instance
• InstanceRemoteAccess
• InstanceState
• IpRange
• Kaktus
• KaktusCPU
• KaktusCaps
• Kawaii
• KawaiiDNatRule
• KawaiiFirewall
• KawaiiFirewallEgressRule
• KawaiiFirewallIngressRule
• KawaiiIpSec
• KawaiiNetIp
• KawaiiNetIpZone
• KawaiiVpcForwardRule
• KawaiiVpcNetIpZone
• KawaiiVpcPeering
• Kiwi
• Kompute
• Konvey
• KonveyBackends
• KonveyEndpoint
• Kylo
• Metadata
• Password
• Project
• ProjectResources
• Region
• RegionSubnet
• StorageNFS
• StoragePool
• Subnet
• Team
• Template
• User
• UserCredentials
• UserEmail
• VNet
• Volume
• Zone