Projects API

Create Project

POST https://v3.cloras.com/api/projects/create

To create a new project and for providing access to given users or to specific groups.

Headers

NameTypeDescription

Authorization

string

Bearer {access_token}

Request Body

NameTypeDescription

project_name

string

Project Name

project_description

string

Project Description

users

array

User Email ID's

groups

array

User Group ID's

{
    "additional_data": {},
    "data": {
        "project_id": "6024f4cc15bea95eea74ef5d"
    },
    "error_code": "",
    "message": "Success",
    "status": 200,
    "success": true
}

Update Project

POST https://v3.cloras.com/api/projects/update/:id

To modify and update the existing project.

Path Parameters

NameTypeDescription

id

string

Project ID

Headers

NameTypeDescription

Authorization

string

Bearer {access_token}

Request Body

NameTypeDescription

users

array

User Email ID's

groups

array

User Group ID's

project_name

string

Project Name

project_description

string

Project Description

{
    "additional_data": {},
    "data": {
        "project_id": "6024f4cc15bea95eea74ef5d"
    },
    "error_code": "",
    "message": "Success",
    "status": 200,
    "success": true
}

Update Project Settings

POST https://v3.cloras.com/workspace/:project_id/api/settings/update

To modify and update the project settings

Path Parameters

NameTypeDescription

project_id

string

Project ID

Headers

NameTypeDescription

Authorization

string

Bearer {access_token}

{
    "errors": {},
    "status": "success"
}

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.

Last updated