MyCloud API

api

v1

websites

/api/v1/websites/stats/<type>/

GET POST OPTIONS

List Create Websites Stats

Open Link

Description
Authentication
Permissions
Filters

Group website statistics by:

type = id, status, user, base_domain, day

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
created_by	Created By
updated_by	Updated By
replicas	Replicas
user	User
subdomain	Subdomain
port	Port
base_domain	Base Domain
networks	Networks
status	Status
last_checked_at	Last Checked At
last_deploy_at	Last Deploy At
save_hash	Save Hash
deploy_hash	Deploy Hash

Request Fields:

{

base_domain: PrimaryKeyRelatedField, Help Text
networks: ManyRelatedField, Help Text

storages: ListSerializer,

Item structure

{

name: CharField, Required

kind: ChoiceField, Required

Choices

Value	Meaning
volume	volume
bind	bind

source: CharField,
mount_path: CharField, Required
read_only: BooleanField,
external: BooleanField,
driver: CharField,
driver_opts: JSONField,

}

image: CharField, Required
replicas: IntegerField,
environment: JSONField,
subdomain: CharField, Required
port: IntegerField, Required

}

Response Fields:

{

id: BigIntegerField,
host: CharField,
stack_name: CharField,
owner_name: CharField,
needs_deploy: SerializerMethodField,
base_domain: PrimaryKeyRelatedField, Help Text
base_domain_label: CharField,
base_domain_name: CharField,
networks: ManyRelatedField, Help Text

storages: ListSerializer,

Item structure

{

id: BigIntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,

kind: ChoiceField,

Choices

Value	Meaning
volume	volume
bind	bind

source: CharField,
mount_path: CharField,
read_only: BooleanField,
external: BooleanField,
driver: CharField,
driver_opts: JSONField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField, Help Text
website: PrimaryKeyRelatedField, Help Text
website_service: PrimaryKeyRelatedField Help Text

}

created: DateTimeField,
modified: DateTimeField,
image: CharField,
replicas: IntegerField,
environment: JSONField,
subdomain: CharField,
port: IntegerField,
status: CharField,
last_checked_at: DateTimeField,
last_deploy_at: DateTimeField,
last_deploy_stdout: CharField,
last_deploy_stderr: CharField,
save_hash: CharField,
deploy_hash: CharField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

/api/v1/websites/<pk>/status/

GET OPTIONS

Check Website Status

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

No input data specified

Response Fields:

No output data specified

/api/v1/websites/<pk>/deploy/

POST OPTIONS

Deploy Website

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

No input data specified

Response Fields:

No output data specified

/api/v1/websites/<pk>/stop/

POST OPTIONS

Stop Website

Open Link

Description
Authentication
Permissions

Scale all services in the stack to 0 replicas. Compose file and
service specs remain on disk; POST /start/ brings them back.

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

No input data specified

Response Fields:

No output data specified

/api/v1/websites/<pk>/start/

POST OPTIONS

Start Website

Open Link

Description
Authentication
Permissions

Scale the stack back up to website.replicas. Inverse of /stop/.

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

No input data specified

Response Fields:

No output data specified

/api/v1/websites/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Website

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

base_domain: PrimaryKeyRelatedField, Help Text
networks: ManyRelatedField, Help Text

storages: ListSerializer,

Item structure

{

name: CharField, Required

kind: ChoiceField, Required

Choices

Value	Meaning
volume	volume
bind	bind

source: CharField,
mount_path: CharField, Required
read_only: BooleanField,
external: BooleanField,
driver: CharField,
driver_opts: JSONField,

}

image: CharField, Required
replicas: IntegerField,
environment: JSONField,
subdomain: CharField, Required
port: IntegerField, Required

}

Response Fields:

{

id: BigIntegerField,
host: CharField,
stack_name: CharField,
owner_name: CharField,
needs_deploy: SerializerMethodField,
base_domain: PrimaryKeyRelatedField, Help Text
base_domain_label: CharField,
base_domain_name: CharField,
networks: ManyRelatedField, Help Text

storages: ListSerializer,

Item structure

{

id: BigIntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,

kind: ChoiceField,

Choices

Value	Meaning
volume	volume
bind	bind

source: CharField,
mount_path: CharField,
read_only: BooleanField,
external: BooleanField,
driver: CharField,
driver_opts: JSONField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField, Help Text
website: PrimaryKeyRelatedField, Help Text
website_service: PrimaryKeyRelatedField Help Text

}

created: DateTimeField,
modified: DateTimeField,
image: CharField,
replicas: IntegerField,
environment: JSONField,
subdomain: CharField,
port: IntegerField,
status: CharField,
last_checked_at: DateTimeField,
last_deploy_at: DateTimeField,
last_deploy_stdout: CharField,
last_deploy_stderr: CharField,
save_hash: CharField,
deploy_hash: CharField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

/api/v1/websites/

GET POST OPTIONS

List Create Websites

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
created_by	Created By
updated_by	Updated By
replicas	Replicas
user	User
subdomain	Subdomain
port	Port
base_domain	Base Domain
networks	Networks
status	Status
last_checked_at	Last Checked At
last_deploy_at	Last Deploy At
save_hash	Save Hash
deploy_hash	Deploy Hash

Request Fields:

{

base_domain: PrimaryKeyRelatedField, Help Text
networks: ManyRelatedField, Help Text

storages: ListSerializer,

Item structure

{

name: CharField, Required

kind: ChoiceField, Required

Choices

Value	Meaning
volume	volume
bind	bind

source: CharField,
mount_path: CharField, Required
read_only: BooleanField,
external: BooleanField,
driver: CharField,
driver_opts: JSONField,

}

image: CharField, Required
replicas: IntegerField,
environment: JSONField,
subdomain: CharField, Required
port: IntegerField, Required

}

Response Fields:

{

id: BigIntegerField,
host: CharField,
stack_name: CharField,
owner_name: CharField,
needs_deploy: SerializerMethodField,
base_domain: PrimaryKeyRelatedField, Help Text
base_domain_label: CharField,
base_domain_name: CharField,
networks: ManyRelatedField, Help Text

storages: ListSerializer,

Item structure

{

id: BigIntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,

kind: ChoiceField,

Choices

Value	Meaning
volume	volume
bind	bind

source: CharField,
mount_path: CharField,
read_only: BooleanField,
external: BooleanField,
driver: CharField,
driver_opts: JSONField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField, Help Text
website: PrimaryKeyRelatedField, Help Text
website_service: PrimaryKeyRelatedField Help Text

}

created: DateTimeField,
modified: DateTimeField,
image: CharField,
replicas: IntegerField,
environment: JSONField,
subdomain: CharField,
port: IntegerField,
status: CharField,
last_checked_at: DateTimeField,
last_deploy_at: DateTimeField,
last_deploy_stdout: CharField,
last_deploy_stderr: CharField,
save_hash: CharField,
deploy_hash: CharField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

/api/v1/websites/<website_pk>/services/

GET POST OPTIONS

List Create Website Services

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
created_by	Created By
updated_by	Updated By
port	Port
replicas	Replicas
subdomain	Subdomain
base_domain	Base Domain
website	Website
name	Name
networks	Networks

Request Fields:

{

base_domain: PrimaryKeyRelatedField, Help Text
networks: ManyRelatedField, Help Text

storages: ListSerializer,

Item structure

{

name: CharField, Required

kind: ChoiceField, Required

Choices

Value	Meaning
volume	volume
bind	bind

source: CharField,
mount_path: CharField, Required
read_only: BooleanField,
external: BooleanField,
driver: CharField,
driver_opts: JSONField,

}

image: CharField, Required
port: IntegerField,
replicas: IntegerField,
environment: JSONField,
subdomain: CharField,
name: CharField, Required

}

Response Fields:

{

id: BigIntegerField,
base_domain: PrimaryKeyRelatedField, Help Text
base_domain_name: CharField,
networks: ManyRelatedField, Help Text

storages: ListSerializer,

Item structure

{

id: BigIntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,

kind: ChoiceField,

Choices

Value	Meaning
volume	volume
bind	bind

source: CharField,
mount_path: CharField,
read_only: BooleanField,
external: BooleanField,
driver: CharField,
driver_opts: JSONField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField, Help Text
website: PrimaryKeyRelatedField, Help Text
website_service: PrimaryKeyRelatedField Help Text

}

host: CharField,
created: DateTimeField,
modified: DateTimeField,
image: CharField,
port: IntegerField,
replicas: IntegerField,
environment: JSONField,
subdomain: CharField,
name: CharField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
website: PrimaryKeyRelatedField Help Text

}

/api/v1/websites/<website_pk>/services/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Website Service

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

base_domain: PrimaryKeyRelatedField, Help Text
networks: ManyRelatedField, Help Text

storages: ListSerializer,

Item structure

{

name: CharField, Required

kind: ChoiceField, Required

Choices

Value	Meaning
volume	volume
bind	bind

source: CharField,
mount_path: CharField, Required
read_only: BooleanField,
external: BooleanField,
driver: CharField,
driver_opts: JSONField,

}

image: CharField, Required
port: IntegerField,
replicas: IntegerField,
environment: JSONField,
subdomain: CharField,
name: CharField, Required

}

Response Fields:

{

id: BigIntegerField,
base_domain: PrimaryKeyRelatedField, Help Text
base_domain_name: CharField,
networks: ManyRelatedField, Help Text

storages: ListSerializer,

Item structure

{

id: BigIntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,

kind: ChoiceField,

Choices

Value	Meaning
volume	volume
bind	bind

source: CharField,
mount_path: CharField,
read_only: BooleanField,
external: BooleanField,
driver: CharField,
driver_opts: JSONField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField, Help Text
website: PrimaryKeyRelatedField, Help Text
website_service: PrimaryKeyRelatedField Help Text

}

host: CharField,
created: DateTimeField,
modified: DateTimeField,
image: CharField,
port: IntegerField,
replicas: IntegerField,
environment: JSONField,
subdomain: CharField,
name: CharField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
website: PrimaryKeyRelatedField Help Text

}

networks

/api/v1/networks/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Network

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

name: CharField, Required
external: BooleanField,
attachable: BooleanField,

}

Response Fields:

{

id: BigIntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
is_default: BooleanField,
external: BooleanField,
attachable: BooleanField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

/api/v1/networks/

GET POST OPTIONS

List Create Networks

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
created_by	Created By
updated_by	Updated By
name	Name
user	User
is_default	Is Default
external	External
attachable	Attachable

Request Fields:

{

name: CharField, Required
external: BooleanField,
attachable: BooleanField,

}

Response Fields:

{

id: BigIntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
is_default: BooleanField,
external: BooleanField,
attachable: BooleanField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

storages

/api/v1/storages/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Storage

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

name: CharField, Required

kind: ChoiceField, Required

Choices

Value	Meaning
volume	volume
bind	bind

source: CharField,
mount_path: CharField, Required
read_only: BooleanField,
external: BooleanField,
driver: CharField,
driver_opts: JSONField,
website: PrimaryKeyRelatedField, Help Text
website_service: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: BigIntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,

kind: ChoiceField,

Choices

Value	Meaning
volume	volume
bind	bind

source: CharField,
mount_path: CharField,
read_only: BooleanField,
external: BooleanField,
driver: CharField,
driver_opts: JSONField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField, Help Text
website: PrimaryKeyRelatedField, Help Text
website_service: PrimaryKeyRelatedField Help Text

}

/api/v1/storages/

GET POST OPTIONS

List Create Storages

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
created_by	Created By
updated_by	Updated By
name	Name
kind	Kind
source	Source
mount_path	Mount Path
read_only	Read Only
external	External
driver	Driver
user	User
website	Website
website_service	Website Service

Request Fields:

{

name: CharField, Required

kind: ChoiceField, Required

Choices

Value	Meaning
volume	volume
bind	bind

source: CharField,
mount_path: CharField, Required
read_only: BooleanField,
external: BooleanField,
driver: CharField,
driver_opts: JSONField,
website: PrimaryKeyRelatedField, Help Text
website_service: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: BigIntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,

kind: ChoiceField,

Choices

Value	Meaning
volume	volume
bind	bind

source: CharField,
mount_path: CharField,
read_only: BooleanField,
external: BooleanField,
driver: CharField,
driver_opts: JSONField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField, Help Text
website: PrimaryKeyRelatedField, Help Text
website_service: PrimaryKeyRelatedField Help Text

}

base\-domains

/api/v1/base\-domains/<pk>/

GET OPTIONS

Retrieve Base Domain

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

No input data specified

Response Fields:

{

id: BigIntegerField,
created: DateTimeField,
modified: DateTimeField,
domain: CharField,
label: CharField,
is_active: BooleanField,
is_default: BooleanField,
cert_resolver: CharField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField Help Text

}

/api/v1/base\-domains/

GET OPTIONS

List Base Domains

Open Link

Description
Authentication
Permissions
Filters

Read-only list of selectable apex domains (e.g. cloud.micha.africa,
cntb.onekana.ke). Inactive rows are excluded so the frontend picker
only shows usable options. Mutations go through Django admin.

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
created_by	Created By
updated_by	Updated By
domain	Domain
label	Label
is_active	Is Active
is_default	Is Default
cert_resolver	Cert Resolver

Request Fields:

No input data specified

Response Fields:

{

id: BigIntegerField,
created: DateTimeField,
modified: DateTimeField,
domain: CharField,
label: CharField,
is_active: BooleanField,
is_default: BooleanField,
cert_resolver: CharField,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField Help Text

}

import

/api/v1/import/

POST OPTIONS

Import Compose

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

MyCloud API

Docker Swarm hosting endpoints

api

v1

websites

List Create Websites Stats

Request Fields:

Response Fields:

Check Website Status

Request Fields:

No input data specified

Response Fields:

No output data specified

Deploy Website

Request Fields:

No input data specified

Response Fields:

No output data specified

Stop Website

Request Fields:

No input data specified

Response Fields:

No output data specified

Start Website

Request Fields:

No input data specified

Response Fields:

No output data specified

Retrieve Update Destroy Website

Request Fields:

Response Fields:

List Create Websites

Request Fields:

Response Fields:

List Create Website Services

Request Fields:

Response Fields:

Retrieve Update Destroy Website Service

Request Fields:

Response Fields:

networks

Retrieve Update Destroy Network

Request Fields:

Response Fields:

List Create Networks

Request Fields:

Response Fields:

storages

Retrieve Update Destroy Storage

Request Fields:

Response Fields:

List Create Storages

Request Fields:

Response Fields:

base\-domains

Retrieve Base Domain

Request Fields:

No input data specified

Response Fields:

List Base Domains

Request Fields:

No input data specified

Response Fields:

import

Import Compose

Request Fields:

No input data specified

Response Fields:

No output data specified