Projects
A Project is the next largest construct after Organization. It contains Devices, Releases, Events, Issues, Deployments, etc.
Route Parameters
The Project
slugshould be used whenever referencing a Project in an API or URL.
Request Schema
| Field | Type | Description |
|---|---|---|
name Required | String | Name of the Project Example: "Awesome Project" |
slug Required | String | A unique URL compatible slug Example: "awesome-project" |
platform | String | The platform of the Project Example: nRF5x |
os | String | The operating system of the Project Example: FreeRTOS |
Query Parameters
The following parameters can be used to filter Projects.
| Query Parameter | Type | Description |
|---|---|---|
name | String[] | Name of the Project Example: "Awesome%20Project" |
platform | String[] | Platform of the Project Example: "nRF5x" |
os | String[] | Operating System of the Project Example: "FreeRTOS" |
| Sort Parameter | Type | Description |
|---|---|---|
created_date | DateTime | Date created |
Response Schema
{
"data": {
"id": 1,
"created_date": "2019-01-19T05:01:13.000000+00:00",
"updated_date": "2019-01-19T05:01:13.000000+00:00",
"name": "Awesome Project",
"slug": "awesome-project",
"platform": "nRF5x",
"os": "FreeRTOS",
"api_key": "87c2ca9d3ec148ac82034fc2724ff614",
"count_devices": 47
}
}
Create a Project
Create a **Project** under the given **Organization**
List Projects
List the **Projects** under a given **Organization**
Retrieve Project
Retrieve a **Project** under a given **Organization**
Update Project
Update a **Project** under a given **Organization**
Delete Project
Delete a **Project** under a given **Organization**
Get Project Client Key
Return the **Project** Client Key
Refresh Project Client Key
Regenerate the **Project** Client Key
Get Project Keys (Data Routes)
Returns all **Project Keys** (Data Routes) for the given **Project**.