@itentialopensource/adapter-cisco_tetration

openapi: 3.0.0 info: title: Cisco Secure Workload 3.5 - OpenAPI description: OpenAPI provides a REST API for Secure Workload features. contact: {} version: '1.0' servers: - url: http://example.com/openapi/v1 variables: {} paths: /applications: get: tags: - Applications summary: ListApplications description: >- This endpoint will return an array of applications that are visible to the users. Parameters: None Response object: Returns an array of application objects. operationId: ListApplications parameters: - name: Content-Type in: header description: '' required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - example: application/json responses: '200': description: '' headers: {} content: {} deprecated: false post: tags: - Applications summary: Createanapplication description: '' operationId: Createanapplication parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateanapplicationRequest' - example: app_scope_id: 5ff73455497d4f1bfc2afda9 name: My Application absolute_policies: - provider_filter_id: 5ff73455497d4f1bfc2afda9 consumer_filter_id: 5ff73455497d4f1bfc2afda9 action: ALLOW l4_params: - proto: 6 port: - 80 - 80 catch_all_action: ALLOW example: app_scope_id: 5ff73455497d4f1bfc2afda9 name: My Application absolute_policies: - provider_filter_id: 5ff73455497d4f1bfc2afda9 consumer_filter_id: 5ff73455497d4f1bfc2afda9 action: ALLOW l4_params: - proto: 6 port: - 80 - 80 catch_all_action: ALLOW required: true responses: '200': description: '' headers: {} content: {} deprecated: false /conversations/6086b98f497d4f07257a13e9: post: tags: - Applications summary: ListApplicationsCopy description: >- This endpoint will return an array of applications that are visible to the users. Parameters: None Response object: Returns an array of application objects. operationId: ListApplicationsCopy parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/ListApplicationsCopyRequest' - example: filter: type: and filters: - type: eq field: excluded value: false - type: lt field: port value: 1000 version: 5 metrics: - byte_count - packet_count limit: 1000 example: filter: type: and filters: - type: eq field: excluded value: false - type: lt field: port value: 1000 version: 5 metrics: - byte_count - packet_count limit: 1000 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /applications/{application_id}: get: tags: - Applications summary: Retrieveasingleapplication description: "This endpoint will return the requested application as a single JSON object.\n\nParameters: The request URL contains the following parameters:\n\n| Name | Type | Description | \n|----------------|--------|--------------------------------------------| \n| application_id | string | The unique identifier for the application. | \n\nResponse object: Returns the application object for the specified ID.\n\n**Sample python code**\n```\napplication_id = '5d02b493755f0237a3d6e078'\nrestclient.get('/applications/%s' % application_id)\n```" operationId: Retrieveasingleapplication parameters: - name: application_id in: path description: '' required: true style: simple schema: type: string example: 'ex: 5e279bff755f023867a7fbe2' - name: Content-Type in: header description: '' required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - example: application/json responses: '200': description: '' headers: {} content: {} deprecated: false delete: tags: - Applications summary: DeleteanApplication description: '' operationId: DeleteanApplication parameters: - name: application_id in: path description: '' required: true style: simple schema: type: string example: 'ex: 60380a6a755f0237b1f2b534' - name: Content-Type in: header description: '' required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - example: application/json responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Applications summary: Updateanapplication description: '' operationId: Updateanapplication parameters: - name: application_id in: path description: '' required: true style: simple schema: type: string example: 'ex: 606d1114755f0223c1a0ef22' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateanapplicationRequest' - example: name: sx2 Name description: Updated Description primary: 'true' example: name: sx2 Name description: Updated Description primary: 'true' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /applications/{application_id}/details: get: tags: - Applications summary: Retrieveapplicationdetails description: '' operationId: Retrieveapplicationdetails parameters: - name: application_id in: path description: '' required: true style: simple schema: type: string example: 'ex: 5fd21268497d4f6de7e48dd9' - name: Content-Type in: header description: '' required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - example: application/json responses: '200': description: '' headers: {} content: {} deprecated: false /applications/{application_id}/versions: get: tags: - Applications summary: ListapplicationVersions description: '' operationId: ListapplicationVersions parameters: - name: application_id in: path description: '' required: true style: simple schema: type: string example: 'ex: 5fd21268497d4f6de7e48dd9' - name: Content-Type in: header description: '' required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - example: application/json responses: '200': description: '' headers: {} content: {} deprecated: false /applications/{application_id}/versions/{version}: delete: tags: - Applications summary: Deleteanapplicationversion description: '' operationId: Deleteanapplicationversion parameters: - name: application_id in: path description: '' required: true style: simple schema: type: string example: 'ex: 6052b229755f0241c6f2b91c' - name: version in: path description: '' required: true style: simple schema: type: string example: 'ex: v5' - name: Content-Type in: header description: '' required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - example: application/json responses: '200': description: '' headers: {} content: {} deprecated: false components: schemas: ListApplicationsCopyRequest: title: ListApplicationsCopyRequest required: - filter - version - metrics - limit type: object properties: filter: allOf: - $ref: '#/components/schemas/Filter' - example: type: and filters: - type: eq field: excluded value: false - type: lt field: port value: 1000 version: type: integer format: int32 metrics: type: array items: type: string description: '' limit: type: integer format: int32 example: filter: type: and filters: - type: eq field: excluded value: false - type: lt field: port value: 1000 version: 5 metrics: - byte_count - packet_count limit: 1000 Filter: title: Filter required: - type - filters type: object properties: type: type: string filters: type: array items: $ref: '#/components/schemas/Filter1' description: '' example: type: and filters: - type: eq field: excluded value: false - type: lt field: port value: 1000 Filter1: title: Filter1 required: - type - field - value type: object properties: type: type: string field: type: string value: oneOf: - type: boolean - type: integer format: int32 example: type: eq field: excluded value: false CreateanapplicationRequest: title: CreateanapplicationRequest required: - app_scope_id - name - absolute_policies - catch_all_action type: object properties: app_scope_id: type: string name: type: string absolute_policies: type: array items: $ref: '#/components/schemas/AbsolutePolicy' description: '' catch_all_action: type: string example: app_scope_id: 5ff73455497d4f1bfc2afda9 name: My Application absolute_policies: - provider_filter_id: 5ff73455497d4f1bfc2afda9 consumer_filter_id: 5ff73455497d4f1bfc2afda9 action: ALLOW l4_params: - proto: 6 port: - 80 - 80 catch_all_action: ALLOW AbsolutePolicy: title: AbsolutePolicy required: - provider_filter_id - consumer_filter_id - action - l4_params type: object properties: provider_filter_id: type: string consumer_filter_id: type: string action: type: string l4_params: type: array items: $ref: '#/components/schemas/L4Param' description: '' example: provider_filter_id: 5ff73455497d4f1bfc2afda9 consumer_filter_id: 5ff73455497d4f1bfc2afda9 action: ALLOW l4_params: - proto: 6 port: - 80 - 80 L4Param: title: L4Param required: - proto - port type: object properties: proto: type: integer format: int32 port: type: array items: type: integer format: int32 description: '' example: proto: 6 port: - 80 - 80 CreateanapplicationCopyRequest: title: CreateanapplicationCopyRequest required: - app_scope_id - name - absolute_policies - catch_all_action type: object properties: app_scope_id: type: string name: type: string absolute_policies: type: array items: $ref: '#/components/schemas/AbsolutePolicy' description: '' catch_all_action: type: string example: app_scope_id: 5ff73455497d4f1bfc2afda9 name: My Application absolute_policies: - provider_filter_id: 5ff73455497d4f1bfc2afda9 consumer_filter_id: 5ff73455497d4f1bfc2afda9 action: ALLOW l4_params: - proto: 6 port: - 80 - 80 catch_all_action: ALLOW UpdateanapplicationRequest: title: UpdateanapplicationRequest required: - name - description - primary type: object properties: name: type: string description: type: string primary: type: string example: name: sx2 Name description: Updated Description primary: 'true' Content-Type: title: Content-Type enum: - application/json type: string example: application/json tags: - name: Applications description: "Application workspaces are the containers for defining, analyzing and enforcing policies for a particular application. For more information about how they work see the Application Workspaces documentation. This set of APIs requires the app_policy_management capability associated with the API key.\n\nThe application JSON object is returned as a single object or an array of objects depending on the API endpoint. The object’s attributes are described below:\n\n| Attribute | Type | Description | \n|----------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| \n| id | string | A unique identifier for the application. | \n| name | string | User specified name of the application. | \n| description | string | User specified description of the application. | \n| app_scope_id | string | ID of the scope assigned to the application. | \n| author | string | First and last name of the user who created the application. | \n| primary | boolean | Indicates if the application is primary for its scope. | \n| alternate_query_mode | boolean | Indicates if ‘dynamic mode’ is used for the application. In the dynamic mode, an ADM run creates one or more candidate queries for each cluster. Default value is true. | \n| created_at | integer | Unix timestamp of when the application was created. | \n| latest_adm_version | integer | The latest adm (v*) version of the application. | \n| enforcement_enabled | boolean | Indicates if enforcement is enabled on the application | \n| enforced_version | integer | The enforced p* version of the application. |"