57 lines
1.1 KiB
Markdown
57 lines
1.1 KiB
Markdown
|
<!-- Code generated by gomarkdoc. DO NOT EDIT -->
|
||
|
|
|
||
|
|
# libcapsul
|
||
|
|
|
||
|
|
```go
|
||
|
|
import "coopcloud.tech/libcapsul"
|
||
|
|
```
|
||
|
|
|
||
|
|
## Index
|
||
|
|
|
||
|
|
- [type CapsulClient](<#type-capsulclient>)
|
||
|
|
- [func New(instanceURL, APIToken string) CapsulClient](<#func-new>)
|
||
|
|
- [func (c CapsulClient) Create(capsulName, capsulType, capsulImage, capsulSSHKey string) (CapsulCreateResponse, error)](<#func-capsulclient-create>)
|
||
|
|
- [type CapsulCreateResponse](<#type-capsulcreateresponse>)
|
||
|
|
|
||
|
|
|
||
|
|
## type CapsulClient
|
||
|
|
|
||
|
|
CapsulClient is a Capsul client interface\.
|
||
|
|
|
||
|
|
```go
|
||
|
|
type CapsulClient struct {
|
||
|
|
InstanceURL string
|
||
|
|
APIToken string
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### func New
|
||
|
|
|
||
|
|
```go
|
||
|
|
func New(instanceURL, APIToken string) CapsulClient
|
||
|
|
```
|
||
|
|
|
||
|
|
New creates a new Capsul client\.
|
||
|
|
|
||
|
|
### func \(CapsulClient\) Create
|
||
|
|
|
||
|
|
```go
|
||
|
|
func (c CapsulClient) Create(capsulName, capsulType, capsulImage, capsulSSHKey string) (CapsulCreateResponse, error)
|
||
|
|
```
|
||
|
|
|
||
|
|
Create creates a new capsul\.
|
||
|
|
|
||
|
|
## type CapsulCreateResponse
|
||
|
|
|
||
|
|
CapsulCreateResponse is a Capsul creation response payload\.
|
||
|
|
|
||
|
|
```go
|
||
|
|
type CapsulCreateResponse struct {
|
||
|
|
ID string
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
|