@@ -338,6 +338,39 @@ paths:
338338 - personalAccessToken : []
339339 tags :
340340 - project
341+ /v1/projects/{projectOrProductUID} :
342+ delete :
343+ operationId : deleteProject
344+ description : Delete a Project by ProjectUID
345+ parameters :
346+ - $ref : ' #/components/parameters/projectOrProductUIDParam'
347+ responses :
348+ ' 200 ' :
349+ description : Successful operation
350+ default :
351+ $ref : ' #/components/responses/ErrorResponse'
352+ security :
353+ - personalAccessToken : []
354+ tags :
355+ - project
356+ get :
357+ operationId : getProject
358+ description : Get a Project by ProjectUID
359+ parameters :
360+ - $ref : ' #/components/parameters/projectOrProductUIDParam'
361+ responses :
362+ ' 200 ' :
363+ description : Successful operation
364+ content :
365+ application/json :
366+ schema :
367+ $ref : ' #/components/schemas/Project'
368+ default :
369+ $ref : ' #/components/responses/ErrorResponse'
370+ security :
371+ - personalAccessToken : []
372+ tags :
373+ - project
341374 /v1/projects/{projectOrProductUID}/alerts :
342375 get :
343376 operationId : getAlerts
@@ -852,6 +885,19 @@ paths:
852885 parameters :
853886 - $ref : ' #/components/parameters/projectOrProductUIDParam'
854887 - $ref : ' #/components/parameters/deviceUIDParam'
888+ - $ref : ' #/components/parameters/startDateParam'
889+ - $ref : ' #/components/parameters/endDateParam'
890+ - name : log_type
891+ in : query
892+ description : Return only specified log types
893+ required : false
894+ schema :
895+ type : array
896+ items :
897+ enum :
898+ - boot
899+ - dfu_completed
900+ type : string
855901 responses :
856902 ' 200 ' :
857903 description : Successful operation
@@ -1106,6 +1152,23 @@ paths:
11061152 - personalAccessToken : []
11071153 tags :
11081154 - device
1155+ /v1/projects/{projectOrProductUID}/devices/{deviceUID}/plans :
1156+ get :
1157+ operationId : getDevicePlans
1158+ description : Get Data Plans associated with the device, this include the primary
1159+ sim, any external sim, as well as any satellite connections.
1160+ responses :
1161+ ' 200 ' :
1162+ $ref : ' #/components/responses/DevicePlansResponse'
1163+ default :
1164+ $ref : ' #/components/responses/ErrorResponse'
1165+ security :
1166+ - api_key : []
1167+ tags :
1168+ - device
1169+ parameters :
1170+ - $ref : ' #/components/parameters/projectOrProductUIDParam'
1171+ - $ref : ' #/components/parameters/deviceUIDParam'
11091172 /v1/projects/{projectOrProductUID}/devices/{deviceUID}/provision :
11101173 post :
11111174 operationId : postProvisionProjectDevice
@@ -2061,7 +2124,7 @@ paths:
20612124 - monitor
20622125 /v1/projects/{projectOrProductUID}/products :
20632126 get :
2064- operationId : getProjectProducts
2127+ operationId : getProducts
20652128 description : Get Products within a Project
20662129 responses :
20672130 ' 200 ' :
@@ -2125,6 +2188,22 @@ paths:
21252188 - personalAccessToken : []
21262189 tags :
21272190 - project
2191+ /v1/projects/{projectOrProductUID}/products/{productUID} :
2192+ delete :
2193+ operationId : deleteProduct
2194+ description : Delete a product
2195+ responses :
2196+ ' 204 ' :
2197+ description : Successful operation
2198+ default :
2199+ $ref : ' #/components/responses/ErrorResponse'
2200+ security :
2201+ - personalAccessToken : []
2202+ tags :
2203+ - project
2204+ parameters :
2205+ - $ref : ' #/components/parameters/projectOrProductUIDParam'
2206+ - $ref : ' #/components/parameters/productUIDParam'
21282207 /v1/projects/{projectOrProductUID}/routes :
21292208 get :
21302209 operationId : getRoutes
@@ -2409,7 +2488,8 @@ paths:
24092488 /v1/projects/{projectOrProductUID}/usage/events :
24102489 get :
24112490 operationId : getProjectEventsUsage
2412- description : Get events usage for a project with time range and period aggregation
2491+ description : Get events usage for a project with time range and period aggregation,
2492+ when endDate is 0 or unspecified the current time is implied
24132493 parameters :
24142494 - $ref : ' #/components/parameters/projectOrProductUIDParam'
24152495 - $ref : ' #/components/parameters/startDateParam'
@@ -2441,7 +2521,8 @@ paths:
24412521 /v1/projects/{projectOrProductUID}/usage/route-logs :
24422522 get :
24432523 operationId : getRouteLogsUsage
2444- description : Get route logs usage for a project with time range and period aggregation
2524+ description : Get route logs usage for a project with time range and period aggregation,
2525+ when endDate is 0 or unspecified the current time is implied
24452526 parameters :
24462527 - $ref : ' #/components/parameters/projectOrProductUIDParam'
24472528 - $ref : ' #/components/parameters/startDateParam'
@@ -2473,7 +2554,8 @@ paths:
24732554 /v1/projects/{projectOrProductUID}/usage/sessions :
24742555 get :
24752556 operationId : getSessionsUsage
2476- description : Get sessions usage for a project with time range and period aggregation
2557+ description : Get sessions usage for a project with time range and period aggregation,
2558+ when endDate is 0 or unspecified the current time is implied
24772559 parameters :
24782560 - $ref : ' #/components/parameters/projectOrProductUIDParam'
24792561 - $ref : ' #/components/parameters/startDateParam'
@@ -2616,39 +2698,6 @@ paths:
26162698 - personalAccessToken : []
26172699 tags :
26182700 - webhook
2619- /v1/projects/{projectUID} :
2620- delete :
2621- operationId : deleteProject
2622- description : Delete a Project by ProjectUID
2623- parameters :
2624- - $ref : ' #/components/parameters/projectOrProductUIDParam'
2625- responses :
2626- ' 200 ' :
2627- description : Successful operation
2628- default :
2629- $ref : ' #/components/responses/ErrorResponse'
2630- security :
2631- - personalAccessToken : []
2632- tags :
2633- - project
2634- get :
2635- operationId : getProject
2636- description : Get a Project by ProjectUID
2637- parameters :
2638- - $ref : ' #/components/parameters/projectOrProductUIDParam'
2639- responses :
2640- ' 200 ' :
2641- description : Successful operation
2642- content :
2643- application/json :
2644- schema :
2645- $ref : ' #/components/schemas/Project'
2646- default :
2647- $ref : ' #/components/responses/ErrorResponse'
2648- security :
2649- - personalAccessToken : []
2650- tags :
2651- - project
26522701components :
26532702 parameters :
26542703 cursorParam :
@@ -3332,6 +3381,41 @@ components:
33323381 properties :
33333382 body :
33343383 type : object
3384+ CellularPlan :
3385+ type : object
3386+ properties :
3387+ activated :
3388+ description : Unix timestamp of when the SIM was activated
3389+ type : integer
3390+ format : int64
3391+ example : 1656010061
3392+ data_usage :
3393+ $ref : ' #/components/schemas/DataUsage'
3394+ expires_at :
3395+ type : integer
3396+ format : int64
3397+ iccid :
3398+ description : The Integrated Circuit Card Identifier of the SIM card
3399+ type : string
3400+ example : ' 345678432765434567890765746354465786'
3401+ imsi :
3402+ description : IMSI of the SIM card
3403+ type : string
3404+ example : ' 310170830688975'
3405+ last_updated :
3406+ description : Time this plan information was last updated
3407+ type : integer
3408+ format : int64
3409+ example : 1656010061
3410+ lifetime_used :
3411+ description : Total bytes used by this SIM
3412+ type : integer
3413+ format : int64
3414+ plan_type :
3415+ description : Description of the SIM plan type including data allowance,
3416+ region, and validity period
3417+ type : string
3418+ example : 500MB, North America, 10-year lifetime
33353419 CellularUsage :
33363420 type : array
33373421 items :
@@ -3496,6 +3580,28 @@ components:
34963580 name :
34973581 description : The name of the field
34983582 type : string
3583+ DataUsage :
3584+ type : object
3585+ properties :
3586+ kb_remaining :
3587+ description : Kilobytes remaining in the plan
3588+ type : number
3589+ format : double
3590+ example : 372.55
3591+ kb_total :
3592+ description : Total Kilobytes included in the plan
3593+ type : number
3594+ format : double
3595+ example : 500
3596+ kb_used :
3597+ description : Kilobytes used to date
3598+ type : number
3599+ format : double
3600+ example : 127.45
3601+ required :
3602+ - kb_total
3603+ - kb_used
3604+ - kb_remaining
34993605 Device :
35003606 type : object
35013607 properties :
@@ -4690,6 +4796,35 @@ components:
46904796 url :
46914797 description : The URL of the route.
46924798 type : string
4799+ SatellitePlan :
4800+ type : object
4801+ properties :
4802+ activated :
4803+ description : Activation date of the satellite plan as Unix timestamp
4804+ type : integer
4805+ format : int64
4806+ example : 1609459200
4807+ billable_bytes :
4808+ $ref : ' #/components/schemas/DataUsage'
4809+ last_updated :
4810+ description : Time this plan information was last updated
4811+ type : integer
4812+ format : int64
4813+ example : 1656010061
4814+ ntn_provider :
4815+ description : Non-Terrestrial Network provider name
4816+ type : string
4817+ example : Skylo
4818+ psid :
4819+ description : Provider-specific identifier for the satellite subscription
4820+ type : string
4821+ example : skylo:5746354465786
4822+ nullable : true
4823+ required :
4824+ - ntn_provider
4825+ - psid
4826+ - activated
4827+ - cumulative_billable_bytes
46934828 SchemaProperty :
46944829 type : object
46954830 properties :
@@ -5769,6 +5904,18 @@ components:
57695904 required :
57705905 - alerts
57715906 - has_more
5907+ DevicePlansResponse :
5908+ description : Response body for /plans
5909+ content :
5910+ application/json :
5911+ schema :
5912+ type : object
5913+ properties :
5914+ cellular_plans :
5915+ type : array
5916+ items :
5917+ $ref : ' #/components/schemas/CellularPlan'
5918+ nullable : true
57725919 DevicesResponse :
57735920 description : List of Devices
57745921 content :
0 commit comments