Sessions

>>>

POST /api/v1/containers/sessions
Create a new Session.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
session
optional , nil allowed

Validations:

  • Must be a Hash
session[name]
required

Name of the Session.

Validations:

  • Must be a String
session[container_ids]
required

Containers included in the Session.

Validations:

  • Must be an array of any type
session[open]
optional , nil allowed

Whether the Session is currently opened.

Validations:

  • Must be one of: true, false.
>>>

PUT /api/v1/containers/sessions/:id
Update a Session.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the Session to be updated.

Validations:

  • Must be a String
session
optional , nil allowed

Validations:

  • Must be a Hash
session[name]
optional

Name of the Session.

Validations:

  • Must be a String
session[container_ids]
optional

Containers included in the Session.

Validations:

  • Must be an array of any type
session[open]
optional , nil allowed

Whether the Session is currently opened.

Validations:

  • Must be one of: true, false.
>>>

DESTROY /api/v1/containers/sessions/:id
Delete a Session.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the Session to destroy.

Validations:

  • Must be a String
>>>

GET /api/v1/session
Display session information about the currently logged in user.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.
>>>

GET /api/v1/session/user_id
Returns the current user id

>>>

GET /api/v1/containers/sessions
Get a list of the current users Sessions.

Metadata

- Authentication: The user must be authenticated to perform this action.