Skip to content

Commit 700c1e5

Browse files
author
CDO Jenkins
committed
Update API docs on service change
1 parent 124a743 commit 700c1e5

File tree

2 files changed

+113
-113
lines changed

2 files changed

+113
-113
lines changed

‎openapi.yaml

+112-112
Original file line numberDiff line numberDiff line change
@@ -1398,6 +1398,118 @@ paths:
13981398
summary: Get Feature Flags
13991399
tags:
14001400
- Tenant Management
1401+
/v1/fmc/gateway/command:
1402+
post:
1403+
description: Send a direct command to the specified device.
1404+
operationId: executeDeviceCommand
1405+
parameters:
1406+
- description: By default, the API waits up to 27 seconds for a device response. Append the 'async' flag to return immediately without waiting for the response.
1407+
in: query
1408+
name: async
1409+
required: false
1410+
schema:
1411+
type: string
1412+
requestBody:
1413+
content:
1414+
application/json:
1415+
schema:
1416+
$ref: '#/components/schemas/DeviceGatewayApiRequest'
1417+
required: true
1418+
responses:
1419+
"200":
1420+
content:
1421+
application/json:
1422+
examples:
1423+
responded:
1424+
value:
1425+
data:
1426+
inResponseTo:
1427+
command: executeFmcRequests
1428+
deviceType: fmc
1429+
deviceUid: fb8e46fc-30b0-437f-921d-606c53d4b94c
1430+
larUid: b5a71c7b-f309-4102-8fa2-9eec2260a1b7
1431+
responseBody: '[{"id":"0050568A-5AB4-0ed3-0000-021474986635","name":"Marketing","agentId":"agent_007","topicName":"aws365","description":"IPs of marketing department","type":"DynamicObject","objectType":"IP","links":{"self":"https://fmc.acme.com/api/fmc_config/v1/domain/e276abe1-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects/0050568C-5AB4-0ed3-0000-021474986635"},"metadata":{"domain":{"name":"Global","id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","type":"Domain"}}}]'
1432+
responseStatus: SUCCESS
1433+
tenantUid: 936fca6c-000b-4375-b903-46e6a95c7153
1434+
requestId: 11111111-1111-1111-1111-111111111111
1435+
responseOrigin: secure-connector
1436+
status: responded
1437+
timeout:
1438+
value:
1439+
data: The request timed out due to a hard limit of 27 seconds. You may poll for a belated response using the url provided in the 'data' field
1440+
requestId: 11111111-1111-1111-1111-111111111111
1441+
responseOrigin: device-gateway-api
1442+
status: timeout
1443+
description: The request was successfully processed, and the device command was executed.
1444+
"500":
1445+
content:
1446+
application/json:
1447+
schema:
1448+
$ref: '#/components/schemas/CommonApiError'
1449+
description: Internal server error.
1450+
summary: Send a direct request to a registered device in Security Cloud Control
1451+
tags:
1452+
- Commands
1453+
/v1/fmc/gateway/command/{requestId}:
1454+
get:
1455+
description: Get the response from a device for a command previously issued.
1456+
operationId: getDeviceCommandResponse
1457+
parameters:
1458+
- description: The unique identifier of the request, represented as a UUID, returned from a previous POST request to the /command endpoint.
1459+
in: path
1460+
name: requestId
1461+
required: true
1462+
schema:
1463+
type: string
1464+
responses:
1465+
"200":
1466+
content:
1467+
application/json:
1468+
examples:
1469+
responded:
1470+
value:
1471+
data:
1472+
inResponseTo:
1473+
command: executeFmcRequests
1474+
deviceType: fmc
1475+
deviceUid: fb8e46fc-30b0-437f-921d-606c53d4b94c
1476+
larUid: b5a71c7b-f309-4102-8fa2-9eec2260a1b7
1477+
responseBody: '[{"id":"0050568A-5AB4-0ed3-0000-021474986635","name":"Marketing","agentId":"agent_007","topicName":"aws365","description":"IPs of marketing department","type":"DynamicObject","objectType":"IP","links":{"self":"https://fmc.acme.com/api/fmc_config/v1/domain/e276abe1-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects/0050568C-5AB4-0ed3-0000-021474986635"},"metadata":{"domain":{"name":"Global","id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","type":"Domain"}}}]'
1478+
responseStatus: SUCCESS
1479+
tenantUid: 936fca6c-000b-4375-b903-46e6a95c7153
1480+
requestId: 11111111-1111-1111-1111-111111111111
1481+
responseOrigin: secure-connector
1482+
status: responded
1483+
description: The device responded. The response may indicate success or contain an error returned by the device.
1484+
"500":
1485+
content:
1486+
application/json:
1487+
schema:
1488+
$ref: '#/components/schemas/CommonApiError'
1489+
description: Internal server error.
1490+
summary: Retrieve the response for a previously sent command
1491+
tags:
1492+
- Commands
1493+
/v1/fmc/gateway/listcommands:
1494+
get:
1495+
description: Retrieve a list of supported device command endpoint patterns.
1496+
operationId: getDeviceCommands
1497+
responses:
1498+
"200":
1499+
content:
1500+
application/json:
1501+
schema:
1502+
$ref: '#/components/schemas/CommandResponse'
1503+
description: The list of supported command patterns.
1504+
"500":
1505+
content:
1506+
application/json:
1507+
schema:
1508+
$ref: '#/components/schemas/CommonApiError'
1509+
description: Internal server error.
1510+
summary: Get supported endpoint patterns
1511+
tags:
1512+
- Commands
14011513
/v1/inventory/devices:
14021514
get:
14031515
description: Get a list of devices in the Security Cloud Control tenant.
@@ -3843,118 +3955,6 @@ paths:
38433955
summary: Get Override Object With Values For Specific Target
38443956
tags:
38453957
- Object Management
3846-
/v1/onpremfmc/gateway/command:
3847-
post:
3848-
description: Send a direct command to the specified device.
3849-
operationId: executeDeviceCommand
3850-
parameters:
3851-
- description: By default, the API waits up to 27 seconds for a device response. Append the 'async' flag to return immediately without waiting for the response.
3852-
in: query
3853-
name: async
3854-
required: false
3855-
schema:
3856-
type: string
3857-
requestBody:
3858-
content:
3859-
application/json:
3860-
schema:
3861-
$ref: '#/components/schemas/DeviceGatewayApiRequest'
3862-
required: true
3863-
responses:
3864-
"200":
3865-
content:
3866-
application/json:
3867-
examples:
3868-
responded:
3869-
value:
3870-
data:
3871-
inResponseTo:
3872-
command: executeFmcRequests
3873-
deviceType: fmc
3874-
deviceUid: fb8e46fc-30b0-437f-921d-606c53d4b94c
3875-
larUid: b5a71c7b-f309-4102-8fa2-9eec2260a1b7
3876-
responseBody: '[{"id":"0050568A-5AB4-0ed3-0000-021474986635","name":"Marketing","agentId":"agent_007","topicName":"aws365","description":"IPs of marketing department","type":"DynamicObject","objectType":"IP","links":{"self":"https://fmc.acme.com/api/fmc_config/v1/domain/e276abe1-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects/0050568C-5AB4-0ed3-0000-021474986635"},"metadata":{"domain":{"name":"Global","id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","type":"Domain"}}}]'
3877-
responseStatus: SUCCESS
3878-
tenantUid: 936fca6c-000b-4375-b903-46e6a95c7153
3879-
requestId: 11111111-1111-1111-1111-111111111111
3880-
responseOrigin: secure-connector
3881-
status: responded
3882-
timeout:
3883-
value:
3884-
data: The request timed out due to a hard limit of 27 seconds. You may poll for a belated response using the url provided in the 'data' field
3885-
requestId: 11111111-1111-1111-1111-111111111111
3886-
responseOrigin: device-gateway-api
3887-
status: timeout
3888-
description: The request was successfully processed, and the device command was executed.
3889-
"500":
3890-
content:
3891-
application/json:
3892-
schema:
3893-
$ref: '#/components/schemas/CommonApiError'
3894-
description: Internal server error.
3895-
summary: Send a direct request to a registered device in Security Cloud Control
3896-
tags:
3897-
- Commands
3898-
/v1/onpremfmc/gateway/command/{requestId}:
3899-
get:
3900-
description: Get the response from a device for a command previously issued.
3901-
operationId: getDeviceCommandResponse
3902-
parameters:
3903-
- description: The unique identifier of the request, represented as a UUID, returned from a previous POST request to the /command endpoint.
3904-
in: path
3905-
name: requestId
3906-
required: true
3907-
schema:
3908-
type: string
3909-
responses:
3910-
"200":
3911-
content:
3912-
application/json:
3913-
examples:
3914-
responded:
3915-
value:
3916-
data:
3917-
inResponseTo:
3918-
command: executeFmcRequests
3919-
deviceType: fmc
3920-
deviceUid: fb8e46fc-30b0-437f-921d-606c53d4b94c
3921-
larUid: b5a71c7b-f309-4102-8fa2-9eec2260a1b7
3922-
responseBody: '[{"id":"0050568A-5AB4-0ed3-0000-021474986635","name":"Marketing","agentId":"agent_007","topicName":"aws365","description":"IPs of marketing department","type":"DynamicObject","objectType":"IP","links":{"self":"https://fmc.acme.com/api/fmc_config/v1/domain/e276abe1-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects/0050568C-5AB4-0ed3-0000-021474986635"},"metadata":{"domain":{"name":"Global","id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","type":"Domain"}}}]'
3923-
responseStatus: SUCCESS
3924-
tenantUid: 936fca6c-000b-4375-b903-46e6a95c7153
3925-
requestId: 11111111-1111-1111-1111-111111111111
3926-
responseOrigin: secure-connector
3927-
status: responded
3928-
description: The device responded. The response may indicate success or contain an error returned by the device.
3929-
"500":
3930-
content:
3931-
application/json:
3932-
schema:
3933-
$ref: '#/components/schemas/CommonApiError'
3934-
description: Internal server error.
3935-
summary: Retrieve the response for a previously sent command
3936-
tags:
3937-
- Commands
3938-
/v1/onpremfmc/gateway/listcommands:
3939-
get:
3940-
description: Retrieve a list of supported device command endpoint patterns.
3941-
operationId: getDeviceCommands
3942-
responses:
3943-
"200":
3944-
content:
3945-
application/json:
3946-
schema:
3947-
$ref: '#/components/schemas/CommandResponse'
3948-
description: The list of supported command patterns.
3949-
"500":
3950-
content:
3951-
application/json:
3952-
schema:
3953-
$ref: '#/components/schemas/CommonApiError'
3954-
description: Internal server error.
3955-
summary: Get supported endpoint patterns
3956-
tags:
3957-
- Commands
39583958
/v1/policies/asa/accessgroups:
39593959
get:
39603960
description: Get a list of ASA Access Groups.

‎postman-collection.json

+1-1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)