Skip to content

Commit 13d2143

Browse files
sra-hubsra-hub
authored
Merge pull request #1060 from sarette/DOCS-8896-Prisma-Browser-Device-Status-Mgmt-api
DOCS-8896 Added device status management APIs
2 parents 284140e + c0bd829 commit 13d2143

File tree

1 file changed

+320
-3
lines changed

1 file changed

+320
-3
lines changed

‎openapi-specs/access/browser-mgmt/PrismaAccess-Browser-Management.yaml‎

Lines changed: 320 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ info:
99
\ the [Prisma Browser User Interface](https://docs.paloaltonetworks.com/prisma-access-browser).\n\
1010
These APIs use the common SASE authentication mechanism and base URL. See the\
1111
\ [Prisma SASE API Get Started](https://pan.dev/sase/docs/getstarted/) guide for\
12-
\ more information. This Open API spec file was created on December 11, 2025.\
13-
\ \xA9 2025 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark\
14-
\ of Palo Alto Networks. A list of our trademarks can be found at [https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html).\
12+
\ more information. This Open API spec file was created on January 02, 2026. \xA9\
13+
\ 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark of\
14+
\ Palo Alto Networks. A list of our trademarks can be found at [https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html).\
1515
\ All other marks mentioned herein may be trademarks of their respective companies."
1616
security:
1717
- BearerAuth: []
@@ -26,6 +26,78 @@ components:
2626
type: string
2727
message:
2828
type: string
29+
missingDeviceIds:
30+
type: array
31+
items:
32+
type: string
33+
description: List of device IDs that were not found (only present for device
34+
not found errors)
35+
DeviceStatusChangeRequest:
36+
type: object
37+
properties:
38+
deviceIds:
39+
type: array
40+
items:
41+
type: string
42+
description: List of device IDs
43+
minItems: 1
44+
required:
45+
- deviceIds
46+
DeviceArchiveResponse:
47+
type: object
48+
properties:
49+
archivedDeviceIds:
50+
type: array
51+
items:
52+
type: string
53+
description: List of device IDs that were archived
54+
message:
55+
type: string
56+
example: 3 devices archived successfully
57+
DeviceRestoreResponse:
58+
type: object
59+
properties:
60+
restoredDeviceIds:
61+
type: array
62+
items:
63+
type: string
64+
description: List of device IDs that were restored
65+
message:
66+
type: string
67+
example: 3 devices restored successfully
68+
DeviceSuspendResponse:
69+
type: object
70+
properties:
71+
suspendedDeviceIds:
72+
type: array
73+
items:
74+
type: string
75+
description: List of device IDs that were suspended
76+
message:
77+
type: string
78+
example: 3 devices suspended successfully
79+
DeviceResumeResponse:
80+
type: object
81+
properties:
82+
resumedDeviceIds:
83+
type: array
84+
items:
85+
type: string
86+
description: List of device IDs that were resumed
87+
message:
88+
type: string
89+
example: 3 devices resumed successfully
90+
DeviceDeleteResponse:
91+
type: object
92+
properties:
93+
deletedDeviceIds:
94+
type: array
95+
items:
96+
type: string
97+
description: List of device IDs that were deleted
98+
message:
99+
type: string
100+
example: 3 devices deleted successfully
29101
Order:
30102
type: string
31103
description: The sort order
@@ -851,6 +923,13 @@ components:
851923
type: string
852924
format: string
853925
description: External identifier
926+
status:
927+
type: string
928+
description: Device status
929+
enum:
930+
- active
931+
- archived
932+
- suspended
854933
firstSeen:
855934
type: string
856935
format: date-time
@@ -988,6 +1067,7 @@ components:
9881067
$ref: '#/components/schemas/User'
9891068
required:
9901069
- id
1070+
- status
9911071
- firstSeen
9921072
- lastSeen
9931073
- osType
@@ -2465,6 +2545,225 @@ paths:
24652545
type: string
24662546
tags:
24672547
- Devices
2548+
/seb-api/v1/devices/archive:
2549+
post:
2550+
summary: Archive Devices
2551+
description: Archive one or more devices by changing their status to archived.
2552+
operationId: PostSeb-apiV1DevicesArchive
2553+
responses:
2554+
'200':
2555+
description: Devices archived successfully
2556+
content:
2557+
application/json:
2558+
schema:
2559+
$ref: '#/components/schemas/DeviceArchiveResponse'
2560+
'400':
2561+
description: Bad request - invalid input
2562+
content:
2563+
application/json:
2564+
schema:
2565+
type: object
2566+
properties:
2567+
errorResponse:
2568+
$ref: '#/components/schemas/ErrorResponse'
2569+
'403':
2570+
description: Forbidden
2571+
'404':
2572+
description: One or more devices not found
2573+
content:
2574+
application/json:
2575+
schema:
2576+
type: object
2577+
properties:
2578+
errorResponse:
2579+
$ref: '#/components/schemas/ErrorResponse'
2580+
'500':
2581+
description: Internal server error
2582+
parameters: []
2583+
tags:
2584+
- Devices
2585+
requestBody:
2586+
required: true
2587+
content:
2588+
application/json:
2589+
schema:
2590+
$ref: '#/components/schemas/DeviceStatusChangeRequest'
2591+
/seb-api/v1/devices/restore:
2592+
post:
2593+
summary: Restore Archived
2594+
description: Restore one or more archived devices by changing their status to
2595+
active.
2596+
operationId: PostSeb-apiV1DevicesRestore
2597+
responses:
2598+
'200':
2599+
description: Devices restored successfully
2600+
content:
2601+
application/json:
2602+
schema:
2603+
$ref: '#/components/schemas/DeviceRestoreResponse'
2604+
'400':
2605+
description: Bad request - invalid input
2606+
content:
2607+
application/json:
2608+
schema:
2609+
type: object
2610+
properties:
2611+
errorResponse:
2612+
$ref: '#/components/schemas/ErrorResponse'
2613+
'403':
2614+
description: Forbidden
2615+
'404':
2616+
description: One or more devices not found
2617+
content:
2618+
application/json:
2619+
schema:
2620+
type: object
2621+
properties:
2622+
errorResponse:
2623+
$ref: '#/components/schemas/ErrorResponse'
2624+
'500':
2625+
description: Internal server error
2626+
parameters: []
2627+
tags:
2628+
- Devices
2629+
requestBody:
2630+
required: true
2631+
content:
2632+
application/json:
2633+
schema:
2634+
$ref: '#/components/schemas/DeviceStatusChangeRequest'
2635+
/seb-api/v1/devices/suspend:
2636+
post:
2637+
summary: Suspend Devices
2638+
description: Suspend one or more devices by changing their status to suspended.
2639+
operationId: PostSeb-apiV1DevicesSuspend
2640+
responses:
2641+
'200':
2642+
description: Devices suspended successfully
2643+
content:
2644+
application/json:
2645+
schema:
2646+
$ref: '#/components/schemas/DeviceSuspendResponse'
2647+
'400':
2648+
description: Bad request - invalid input
2649+
content:
2650+
application/json:
2651+
schema:
2652+
type: object
2653+
properties:
2654+
errorResponse:
2655+
$ref: '#/components/schemas/ErrorResponse'
2656+
'403':
2657+
description: Forbidden
2658+
'404':
2659+
description: One or more devices not found
2660+
content:
2661+
application/json:
2662+
schema:
2663+
type: object
2664+
properties:
2665+
errorResponse:
2666+
$ref: '#/components/schemas/ErrorResponse'
2667+
'500':
2668+
description: Internal server error
2669+
parameters: []
2670+
tags:
2671+
- Devices
2672+
requestBody:
2673+
required: true
2674+
content:
2675+
application/json:
2676+
schema:
2677+
$ref: '#/components/schemas/DeviceStatusChangeRequest'
2678+
/seb-api/v1/devices/resume:
2679+
post:
2680+
summary: Resume Suspended Devices
2681+
description: Resume one or more suspended devices by changing their status to
2682+
active.
2683+
operationId: PostSeb-apiV1DevicesResume
2684+
responses:
2685+
'200':
2686+
description: Devices resumed successfully
2687+
content:
2688+
application/json:
2689+
schema:
2690+
$ref: '#/components/schemas/DeviceResumeResponse'
2691+
'400':
2692+
description: Bad request - invalid input
2693+
content:
2694+
application/json:
2695+
schema:
2696+
type: object
2697+
properties:
2698+
errorResponse:
2699+
$ref: '#/components/schemas/ErrorResponse'
2700+
'403':
2701+
description: Forbidden
2702+
'404':
2703+
description: One or more devices not found
2704+
content:
2705+
application/json:
2706+
schema:
2707+
type: object
2708+
properties:
2709+
errorResponse:
2710+
$ref: '#/components/schemas/ErrorResponse'
2711+
'500':
2712+
description: Internal server error
2713+
parameters: []
2714+
tags:
2715+
- Devices
2716+
requestBody:
2717+
required: true
2718+
content:
2719+
application/json:
2720+
schema:
2721+
$ref: '#/components/schemas/DeviceStatusChangeRequest'
2722+
/seb-api/v1/devices/delete:
2723+
post:
2724+
summary: Delete Devices
2725+
description: Delete one or more devices permanently. **Note:** Suspended devices
2726+
cannot be deleted - they must be resumed first.
2727+
operationId: PostSeb-apiV1DevicesDelete
2728+
responses:
2729+
'200':
2730+
description: Devices deleted successfully
2731+
content:
2732+
application/json:
2733+
schema:
2734+
$ref: '#/components/schemas/DeviceDeleteResponse'
2735+
'400':
2736+
description: Bad request - invalid input or attempting to delete suspended
2737+
devices
2738+
content:
2739+
application/json:
2740+
schema:
2741+
type: object
2742+
properties:
2743+
errorResponse:
2744+
$ref: '#/components/schemas/ErrorResponse'
2745+
'403':
2746+
description: Forbidden
2747+
'404':
2748+
description: One or more devices not found
2749+
content:
2750+
application/json:
2751+
schema:
2752+
type: object
2753+
properties:
2754+
errorResponse:
2755+
$ref: '#/components/schemas/ErrorResponse'
2756+
'500':
2757+
description: Internal server error
2758+
parameters: []
2759+
tags:
2760+
- Devices
2761+
requestBody:
2762+
required: true
2763+
content:
2764+
application/json:
2765+
schema:
2766+
$ref: '#/components/schemas/DeviceStatusChangeRequest'
24682767
/seb-api/v1/device-groups:
24692768
get:
24702769
summary: List Device Groups
@@ -2571,6 +2870,15 @@ paths:
25712870
required: false
25722871
schema:
25732872
$ref: '#/components/schemas/Order'
2873+
- name: configurationVersion
2874+
in: query
2875+
description: Configuration version to retrieve (draft, active, or version
2876+
number)
2877+
required: false
2878+
schema:
2879+
type: string
2880+
default: draft
2881+
pattern: ^([dD]raft|[aA]ctive|[1-9][0-9]{0,9}|0CV[0-9A-Z]{26})$
25742882
tags:
25752883
- DeviceGroups
25762884
post:
@@ -2656,6 +2964,15 @@ paths:
26562964
required: true
26572965
schema:
26582966
type: string
2967+
- name: configurationVersion
2968+
in: query
2969+
description: Configuration version to retrieve (draft, active, or version
2970+
number)
2971+
required: false
2972+
schema:
2973+
type: string
2974+
default: draft
2975+
pattern: ^([dD]raft|[aA]ctive|[1-9][0-9]{0,9}|0CV[0-9A-Z]{26})$
26592976
tags:
26602977
- DeviceGroups
26612978
put:

0 commit comments

Comments
 (0)