Projects
Retrieves a list of all projects accessible by the authenticated user. Projects are returned sorted by creation date (newest first). If an API key is scoped to a specific project, only that project will be returned.
Use Cases:
List all projects in your account
View project organization and structure
Get project IDs for subsequent device and data operations
Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"
Projects retrieved successfully - Returns an array of project objects
Unauthorized - Invalid or missing API key
GET /v2/projects HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Accept: */*
[
{
"created_at": "2024-01-15T10:30:00Z",
"description": "Production environment IoT devices",
"id": "3e5c0246-c759-48e8-8345-27db13f11ff7",
"name": "Production IoT Fleet",
"tags": [
"production",
"fleet",
"monitoring"
]
}
]Creates a new project in your account. Projects are containers for organizing devices and their data. After creation, devices can be added to the project using the devices API.
Required Fields:
name: Project name (max 100 characters)
description: Project description (max 500 characters)
Optional Fields:
tags: Array of alphanumeric tags for categorization (e.g., ["production", "us_west", "temperature_sensors"])
Permissions:
For individual plans: Project created with requester as admin
For organization plans: Project shared with organization superadmins
Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"
Project creation timestamp (ISO 8601 format, UTC)
2024-01-15T10:30:00ZProject description (required, max 500 characters)
Production environment IoT devicesUnique project identifier (UUID format)
3e5c0246-c759-48e8-8345-27db13f11ff7Project name (required, max 100 characters)
Production IoT FleetOptional tags for categorization (alphanumeric and underscore only)
["production","fleet","monitoring"]Project created successfully - Returns the created project with generated ID
Invalid request body - Check required fields and format
Unauthorized - Invalid or missing API key
POST /v2/projects HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 205
{
"created_at": "2024-01-15T10:30:00Z",
"description": "Production environment IoT devices",
"id": "3e5c0246-c759-48e8-8345-27db13f11ff7",
"name": "Production IoT Fleet",
"tags": [
"production",
"fleet",
"monitoring"
]
}{
"created_at": "2024-01-15T10:30:00Z",
"description": "Production environment IoT devices",
"id": "3e5c0246-c759-48e8-8345-27db13f11ff7",
"name": "Production IoT Fleet",
"tags": [
"production",
"fleet",
"monitoring"
]
}Retrieves detailed information about a specific project including name, description, creation timestamp, and tags.
Use Cases:
View project configuration and metadata
Verify project details before operations
Audit project information
Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"
Project ID (UUID format)
3e5c0246-c759-48e8-8345-27db13f11ff7Project retrieved successfully
Unauthorized - Invalid or missing API key
Project not found or access denied
GET /v2/projects/{project_id} HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Accept: */*
{
"created_at": "2024-01-15T10:30:00Z",
"description": "Production environment IoT devices",
"id": "3e5c0246-c759-48e8-8345-27db13f11ff7",
"name": "Production IoT Fleet",
"tags": [
"production",
"fleet",
"monitoring"
]
}⚠️ WARNING: Permanently deletes a project and ALL its associated resources including devices, historical data, dashboards, and configurations. This action cannot be undone.
What Gets Deleted:
All devices in the project
All historical time-series data
All device configurations and functions
All aggregated data views
Project settings and metadata
Prerequisites:
Must have admin or owner permissions
Project must exist and be accessible
Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"
Project ID (UUID format)
3e5c0246-c759-48e8-8345-27db13f11ff7Project deleted successfully
Unauthorized - Invalid or missing API key
Forbidden - Insufficient permissions
Project not found
DELETE /v2/projects/{project_id} HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Accept: */*
{
"action": "delete device",
"message": "Operation completed successfully",
"success": true
}Share project access with users or groups in your organization. Invited members will receive email notifications and gain access based on their assigned role.
Project Roles:
owner
Full control: read, write, delete, access management, device/function management, aggregated views
admin
Full control: same as owner (read, write, delete, access management, device/function management)
readwrite
Read and modify: read, write, device management, function management, aggregated views (cannot delete project or manage access)
readonly
View only: read project, devices, functions, and aggregated views (no modifications)
Custom Roles: In addition to default roles, organizations can create custom roles with specific permission combinations.
Prerequisites:
Must have
access-managementpermission on the projectOrganization plan required for group invitations
Users must exist in your organization
Role must be a valid project role ID
Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"
Project ID (UUID format)
3e5c0246-c759-48e8-8345-27db13f11ff7Invitation sent successfully - Users will receive email notifications
Invalid request body - Check email format and role values (must be: owner, admin, readwrite, readonly, or custom role ID)
Unauthorized - Invalid or missing API key
Project not found
POST /v2/projects/{project_id}/invite HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 123
{
"groups": [
{
"id": "5f8d0d55b54764ca6f3a1234",
"role": "readwrite"
}
],
"users": [
{
"email": "[email protected]",
"role": "readwrite"
}
]
}{
"action": "delete device",
"message": "Operation completed successfully",
"success": true
}Last updated