All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| create_project | POST /v2/projects | Create Project |
| delete_project | DELETE /v2/projects/{proj_id} | Delete Project |
| get_project | GET /v2/projects/{proj_id} | Get Project |
| list_projects | GET /v2/projects | List Projects |
| update_project | PATCH /v2/projects/{proj_id} | Update Project |
models::ProjectRead create_project(project_create) Create Project
Creates a new project under the active organization.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| project_create | ProjectCreate | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_project(proj_id) Delete Project
Deletes the project and all its related data.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| proj_id | String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). | [required] |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::ProjectRead get_project(proj_id) Get Project
Gets a single project matching the given proj_id, if such project exists.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| proj_id | String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). | [required] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::ProjectRead list_projects(page, per_page) List Projects
Lists all the projects under the active organization.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| page | Option<i32> | Page number of the results to fetch, starting at 1. | [default to 1] | |
| per_page | Option<i32> | The number of results per page (max 100). | [default to 30] |
Vecmodels::ProjectRead
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::ProjectRead update_project(proj_id, project_update) Update Project
Updates the project.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| proj_id | String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). | [required] | |
| project_update | ProjectUpdate | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]