Skip to content

Commit 1510bc3

Browse files
committed
Update agent/Explorer update API documentation
1 parent 7efbe92 commit 1510bc3

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

runzero-api.yml

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ servers:
44
url: https://console.runzero.com/api/v1.0
55
info:
66
description: runZero API. API use is rate limited, you can make as many calls per day as you have licensed assets.
7-
version: 4.0.250611.0
7+
version: 4.0.250826.0
88
title: runZero API
99
contact:
1010
email: support@runzero.com
@@ -1275,8 +1275,8 @@ paths:
12751275
patch:
12761276
tags:
12771277
- Organization
1278-
operationId: updateAgentSite
1279-
summary: Update the site associated with agent. Legacy path for /org/explorers/{explorer_id}
1278+
operationId: updateAgentSettings
1279+
summary: Update the settings associated with the agent. Legacy path for /org/explorers/{explorer_id}
12801280
parameters:
12811281
- in: path
12821282
name: agent_id
@@ -1286,12 +1286,12 @@ paths:
12861286
required: true
12871287
description: UUID of the agent to update
12881288
requestBody:
1289-
description: site_id to associate with the agent
1289+
description: The updated settings to apply to the agent
12901290
required: true
12911291
content:
12921292
application/json:
12931293
schema:
1294-
$ref: "#/components/schemas/AgentSiteID"
1294+
$ref: "#/components/schemas/AgentPatchedSettings"
12951295
responses:
12961296
'200':
12971297
description: agent details
@@ -1401,9 +1401,9 @@ paths:
14011401
patch:
14021402
tags:
14031403
- Organization
1404-
operationId: updateExplorerSite
1405-
summary: Update the site associated with the explorer
1406-
description: Update the site associated with the explorer. This is the same call as legacy path /org/agents/{agent_id}
1404+
operationId: updateExplorerSettings
1405+
summary: Update the settings associated with the Explorer
1406+
description: Update the settings associated with the Explorer. This is the same call as legacy path /org/agents/{agent_id}
14071407
parameters:
14081408
- in: path
14091409
name: explorer_id
@@ -1413,12 +1413,12 @@ paths:
14131413
required: true
14141414
description: UUID of the explorer to update
14151415
requestBody:
1416-
description: site_id to associate with the explorer
1416+
description: The updated settings to apply to the Explorer
14171417
required: true
14181418
content:
14191419
application/json:
14201420
schema:
1421-
$ref: "#/components/schemas/ExplorerSiteID"
1421+
$ref: "#/components/schemas/ExplorerPatchedSettings"
14221422
responses:
14231423
'200':
14241424
description: explorer details
@@ -5976,21 +5976,26 @@ components:
59765976

59775977

59785978

5979-
AgentSiteID:
5979+
AgentPatchedSettings:
59805980
type: object
5981-
required:
5982-
- site_id
59835981
properties:
59845982
site_id:
59855983
type: string
59865984
format: uuid
59875985
example: "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8"
5986+
settings:
5987+
type: object
5988+
properties:
5989+
max_concurrent_scans:
5990+
type: integer
5991+
format: int64
5992+
example: 5
59885993

59895994
Explorer:
59905995
$ref: '#/components/schemas/Agent'
59915996

5992-
ExplorerSiteID:
5993-
$ref: '#/components/schemas/AgentSiteID'
5997+
ExplorerPatchedSettings:
5998+
$ref: '#/components/schemas/AgentPatchedSettings'
59945999

59956000
OrgOptions:
59966001
type: object

0 commit comments

Comments
 (0)