Projects

post
Create Project

https://v3.cloras.com/api/projects/create
To create a new project and for providing access to given users or to specific groups.
Request
Response
Request
Headers
Authorization
required
string
Bearer {access_token}
Body Parameters
project_name
required
string
Project Name
project_description
required
string
Project Description
users
optional
array
User Email ID's
groups
optional
array
User Group ID's
Response
200: OK
Successfull Response
{
"additional_data": {},
"data": {
"project_id": "6024f4cc15bea95eea74ef5d"
},
"error_code": "",
"message": "Success",
"status": 200,
"success": true
}
401: Unauthorized
Authentication Error
{
"data": null,
"message": "UserWarning('Suspicious login attempt',)",
"response_status": 401,
"status": false,
"status_code": 401
}

post
Update Project

https://v3.cloras.com/api/projects/update/:id
To modify and update the existing project.
Request
Response
Request
Path Parameters
id
required
string
Project ID
Headers
Authorization
required
string
Bearer {access_token}
Body Parameters
users
optional
array
User Email ID's
groups
optional
array
User Group ID's
project_name
optional
string
Project Name
project_description
optional
string
Project Description
Response
200: OK
Successfull Response
{
"additional_data": {},
"data": {
"project_id": "6024f4cc15bea95eea74ef5d"
},
"error_code": "",
"message": "Success",
"status": 200,
"success": true
}
401: Unauthorized
Authentication Error
{
"data": null,
"message": "UserWarning('Suspicious login attempt',)",
"response_status": 401,
"status": false,
"status_code": 401
}

post
Update Project Settings

https://v3.cloras.com/workspace/:project_id/api/settings/update
To modify and update the project settings
Request
Response
Request
Path Parameters
project_id
required
string
Project ID
Headers
Authorization
required
string
Bearer {access_token}
Response
200: OK
{
"errors": {},
"status": "success"
}
401: Unauthorized
{
"data": null,
"message": "UserWarning('Suspicious login attempt',)",
"response_status": 401,
"status": false,
"status_code": 401
}

Body Parameters

{
"general___timezone: "America/Juneau",
"activity_logs___activity_logs":false,
"projects_console___default_console_options":{"api_method":true,"api_request":true,"api_response":false, "api_headers": false, "api_params": false},
"projects_console___projects_console":false
}

To enable project activity logs, provide the key activity_logs___activity_logs with value true in body parameters and all the other settings can be modified in the same way.

Only Project Owner can modify the project settings. Project Administrators are not allowed to modify/update the project settings through API.