api

Documentation

Index

• type App
• type AppCreateRequest
• type AppRunRequest
• type AppRunResponse
• type Apps
• type AuthLoginRequest
• type AuthLoginResponse
• type AuthPasswdRequest
• type AuthRegenerateRequest
• type AuthRegenerateResponse
• type AuthRegisterRequest
• type Build
• type Builds
• type Cert
• type CertCreateRequest
• type Certs
• type Config
• type ConfigSet
• type ConfigUnset
• type CreateBuildRequest
• type Domain
• type DomainCreateRequest
• type Domains
• type Key
• type KeyCreateRequest
• type Keys
• type PermsAdminResponse
• type PermsAppResponse
• type PermsRequest
• type Process
• type Processes
• type Release
• type ReleaseRollback
• type Releases
• type User
• type Users

Types

type App

type App struct {
	Created string `json:"created"`
	ID      string `json:"id"`
	Owner   string `json:"owner"`
	Updated string `json:"updated"`
	URL     string `json:"url"`
	UUID    string `json:"uuid"`
}

App is the definition of the app object.

type AppCreateRequest

type AppCreateRequest struct {
	ID string `json:"id,omitempty"`
}

AppCreateRequest is the definition of POST /v1/apps/.

type AppRunRequest

type AppRunRequest struct {
	Command string `json:"command"`
}

AppRunRequest is the definition of POST /v1/apps/<app id>/run.

type AppRunResponse

type AppRunResponse struct {
	Output     string `json:"output"`
	ReturnCode int    `json:"rc"`
}

AppRunResponse is the definition of /v1/apps/<app id>/run.

type Apps

type Apps struct {
	Count    int   `json:"count"`
	Next     int   `json:"next"`
	Previous int   `json:"previous"`
	Apps     []App `json:"results"`
}

Apps is the definition of GET /v1/apps/.

type AuthLoginRequest

type AuthLoginRequest struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

AuthLoginRequest is the definition of POST /v1/auth/login/.

type AuthLoginResponse

type AuthLoginResponse tokenResponse

AuthLoginResponse is the definition of /v1/auth/login/.

type AuthPasswdRequest

type AuthPasswdRequest struct {
	Username    string `json:"username,omitempty"`
	Password    string `json:"password"`
	NewPassword string `json:"new_password"`
}

AuthPasswdRequest is the definition of POST /v1/auth/passwd/.

type AuthRegenerateRequest

type AuthRegenerateRequest struct {
	Name string `json:"username,omitempty"`
	All  bool   `json:"all,omitempty"`
}

AuthRegenerateRequest is the definition of POST /v1/auth/tokens/.

type AuthRegenerateResponse

type AuthRegenerateResponse tokenResponse

AuthRegenerateResponse is the definition of /v1/auth/tokens/.

type AuthRegisterRequest

type AuthRegisterRequest struct {
	Username  string `json:"username"`
	Password  string `json:"password"`
	Email     string `json:"email"`
	FirstName string `json:"first_name,omitempty"`
	LastName  string `json:"last_name,omitempty"`
}

AuthRegisterRequest is the definition of POST /v1/auth/register/.

type Build

type Build struct {
	App        string            `json:"app"`
	Created    string            `json:"created"`
	Dockerfile string            `json:"dockerfile,omitempty"`
	Image      string            `json:"image,omitempty"`
	Owner      string            `json:"owner"`
	Procfile   map[string]string `json:"procfile"`
	Sha        string            `json:"sha,omitempty"`
	Updated    string            `json:"updated"`
	UUID       string            `json:"uuid"`
}

Build is the structure of the build object.

type Builds

type Builds struct {
	Count    int     `json:"count"`
	Next     int     `json:"next"`
	Previous int     `json:"previous"`
	Builds   []Build `json:"results"`
}

Builds is the structure of GET /v1/apps/<app id>/builds/.

type Cert

type Cert struct {
	Updated string `json:"updated,omitempty"`
	Created string `json:"created,omitempty"`
	Name    string `json:"common_name"`
	Expires string `json:"expires"`
	Owner   string `json:"owner,omitempty"`
	ID      int    `json:"id,omitempty"`
}

Cert is the definition of the cert object. Some fields are omtempty because they are only returned when creating or getting a cert.

type CertCreateRequest

type CertCreateRequest struct {
	Certificate string `json:"certificate"`
	Key         string `json:"key"`
	Name        string `json:"common_name,omitempty"`
}

CertCreateRequest is the definition of POST /v1/certs/.

type Certs

type Certs struct {
	Count    int    `json:"count"`
	Next     int    `json:"next"`
	Previous int    `json:"previous"`
	Certs    []Cert `json:"results"`
}

Certs is the definition of GET /v1/certs/.

type Config

type Config struct {
	Owner   string                 `json:"owner,omitempty"`
	App     string                 `json:"app,omitempty"`
	Values  map[string]interface{} `json:"values,omitempty"`
	Memory  map[string]interface{} `json:"memory,omitempty"`
	CPU     map[string]interface{} `json:"cpu,omitempty"`
	Tags    map[string]interface{} `json:"tags,omitempty"`
	Created string                 `json:"created,omitempty"`
	Updated string                 `json:"updated,omitempty"`
	UUID    string                 `json:"uuid,omitempty"`
}

Config is the structure of an app's config.

type ConfigSet

type ConfigSet struct {
	Values map[string]string `json:"values"`
}

ConfigSet is the definition of POST /v1/apps/<app id>/config/.

type ConfigUnset

type ConfigUnset struct {
	Values map[string]interface{} `json:"values"`
}

ConfigUnset is the definition of POST /v1/apps/<app id>/config/.

type CreateBuildRequest

type CreateBuildRequest struct {
	Image    string            `json:"image"`
	Procfile map[string]string `json:"procfile,omitempty"`
}

CreateBuildRequest is the structure of POST /v1/apps/<app id>/builds/.

type Domain

type Domain struct {
	App     string `json:"app"`
	Created string `json:"created"`
	Domain  string `json:"domain"`
	Owner   string `json:"owner"`
	Updated string `json:"updated"`
}

Domain is the structure of the domain object.

type DomainCreateRequest

type DomainCreateRequest struct {
	Domain string `json:"domain"`
}

DomainCreateRequest is the structure of POST /v1/app/<app id>/domains/.

type Domains

type Domains struct {
	Count    int      `json:"count"`
	Next     int      `json:"next"`
	Previous int      `json:"previous"`
	Domains  []Domain `json:"results"`
}

Domains is the structure of GET /v1/app/<app id>/domains/.

type Key

type Key struct {
	Created string `json:"created"`
	ID      string `json:"id"`
	Owner   string `json:"owner"`
	Public  string `json:"public"`
	Updated string `json:"updated"`
	UUID    string `json:"uuid"`
}

Key is the definition of the key object.

type KeyCreateRequest

type KeyCreateRequest struct {
	ID     string `json:"id"`
	Public string `json:"public"`
	Name   string `json:"name,omitempty"`
}

KeyCreateRequest is the definition of POST /v1/keys/.

type Keys

type Keys struct {
	Count    int   `json:"count"`
	Next     int   `json:"next"`
	Previous int   `json:"previous"`
	Keys     []Key `json:"results"`
}

Keys is the definition of GET /v1/keys/.

type PermsAdminResponse

type PermsAdminResponse struct {
	Count    int `json:"count"`
	Next     int `json:"next"`
	Previous int `json:"previous"`
	Users    []struct {
		Username string `json:"username"`
	} `json:"results"`
}

PermsAdminResponse is the definition of GET /v1/admin/perms/.

type PermsAppResponse

type PermsAppResponse struct {
	Users []string `json:"users"`
}

PermsAppResponse is the definition of GET /v1/apps/<app id>/perms/.

type PermsRequest

type PermsRequest struct {
	Username string `json:"username"`
}

PermsRequest is the definition of a requst on /perms/.

type Process

type Process struct {
	Owner   string `json:"owner"`
	App     string `json:"app"`
	Release string `json:"release"`
	Created string `json:"created"`
	Updated string `json:"updated"`
	UUID    string `json:"uuid"`
	Type    string `json:"type"`
	Num     int    `json:"num"`
	State   string `json:"state"`
}

Process defines the structure of a process.

type Processes

type Processes struct {
	Count     int       `json:"count"`
	Next      int       `json:"next"`
	Previous  int       `json:"previous"`
	Processes []Process `json:"results"`
}

Processes defines the structure of processes.

type Release

type Release struct {
	App     string `json:"app"`
	Build   string `json:"build,omitempty"`
	Config  string `json:"config"`
	Created string `json:"created"`
	Owner   string `json:"owner"`
	Summary string `json:"summary"`
	Updated string `json:"updated"`
	UUID    string `json:"uuid"`
	Version int    `json:"version"`
}

Release is the definition of the release object.

type ReleaseRollback

type ReleaseRollback struct {
	Version int `json:"version"`
}

ReleaseRollback is the defenition of POST /v1/apps/<app id>/releases/.

type Releases

type Releases struct {
	Count    int       `json:"count"`
	Next     int       `json:"next"`
	Previous int       `json:"previous"`
	Releases []Release `json:"results"`
}

Releases is the definition of GET /v1/apps/<app id>/releases/.

type User

type User struct {
	ID          int    `json:"id"`
	LastLogin   string `json:"last_login"`
	IsSuperuser bool   `json:"is_superuser"`
	Username    string `json:"username"`
	FirstName   string `json:"first_name"`
	LastName    string `json:"last_name"`
	Email       string `json:"email"`
	IsStaff     bool   `json:"is_staff"`
	IsActive    bool   `json:"is_active"`
	DateJoined  string `json:"date_joined"`
}

User is the definition of the user object.

type Users

type Users struct {
	Count    int    `json:"count"`
	Next     int    `json:"next"`
	Previous int    `json:"previous"`
	Users    []User `json:"results"`
}

Users is the definition of GET /v1/users.