MyCloud API

api

• v1

  • websites

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

        GET POST OPTIONS

        List Create Websites Stats

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        Group website statistics by:

        
        

        type = id, status, user, 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
        user	User
        subdomain	Subdomain
        port	Port
        replicas	Replicas
        status	Status
        last_checked_at	Last Checked At
        last_deploy_at	Last Deploy At

        
        

        Request Fields:

        {

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

        }

        
        

        Response Fields:

        {

        • id: BigIntegerField,
        • host: CharField,
        • stack_name: CharField,
        • owner_name: CharField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • subdomain: CharField,
        • image: CharField,
        • port: IntegerField,
        • replicas: IntegerField,
        • environment: JSONField,
        • status: CharField,
        • last_checked_at: DateTimeField,
        • last_deploy_at: DateTimeField,
        • last_deploy_stdout: CharField,
        • last_deploy_stderr: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/websites/<pk>/status/

        GET OPTIONS

        Check Website Status

        Copy to clipboard Copy Link

        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

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

        POST OPTIONS

        Deploy Website

        Copy to clipboard Copy Link

        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

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

        POST OPTIONS

        Stop Website

        Copy to clipboard Copy Link

        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

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

        POST OPTIONS

        Start Website

        Copy to clipboard Copy Link

        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

    • • swap_horiz /api/v1/websites/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Website

        Copy to clipboard Copy Link

        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:

        {

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

        }

        
        

        Response Fields:

        {

        • id: BigIntegerField,
        • host: CharField,
        • stack_name: CharField,
        • owner_name: CharField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • subdomain: CharField,
        • image: CharField,
        • port: IntegerField,
        • replicas: IntegerField,
        • environment: JSONField,
        • status: CharField,
        • last_checked_at: DateTimeField,
        • last_deploy_at: DateTimeField,
        • last_deploy_stdout: CharField,
        • last_deploy_stderr: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/websites/

        GET POST OPTIONS

        List Create Websites

        Copy to clipboard Copy Link

        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
        user	User
        subdomain	Subdomain
        port	Port
        replicas	Replicas
        status	Status
        last_checked_at	Last Checked At
        last_deploy_at	Last Deploy At

        
        

        Request Fields:

        {

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

        }

        
        

        Response Fields:

        {

        • id: BigIntegerField,
        • host: CharField,
        • stack_name: CharField,
        • owner_name: CharField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • subdomain: CharField,
        • image: CharField,
        • port: IntegerField,
        • replicas: IntegerField,
        • environment: JSONField,
        • status: CharField,
        • last_checked_at: DateTimeField,
        • last_deploy_at: DateTimeField,
        • last_deploy_stdout: CharField,
        • last_deploy_stderr: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }