openapi: 3.0.0 info: version: 2015-07-09 x-release: v4 title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Device Posture Rules API description: Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Device Posture Rules paths: /accounts/{account_id}/devices/posture: get: description: Fetches device posture rules for a Zero Trust account. operationId: device-posture-rules-list-device-posture-rules parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: List device posture rules response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_response_collection' description: List device posture rules response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform List device posture rules tags: - Device Posture Rules x-api-token-group: - Teams Read - Teams Write post: description: Creates a new device posture rule. operationId: device-posture-rules-create-device-posture-rule parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: schema: properties: description: $ref: '#/components/schemas/teams-devices_description' expiration: $ref: '#/components/schemas/teams-devices_expiration' input: $ref: '#/components/schemas/teams-devices_input' match: $ref: '#/components/schemas/teams-devices_match' name: $ref: '#/components/schemas/teams-devices_name' schedule: $ref: '#/components/schemas/teams-devices_schedule' type: $ref: '#/components/schemas/teams-devices_type' required: - name - type required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Create device posture rule response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_single_response' description: Create device posture rule response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Create a device posture rule tags: - Device Posture Rules x-api-token-group: - Teams Write /accounts/{account_id}/devices/posture/{rule_id}: delete: description: Deletes a device posture rule. operationId: device-posture-rules-delete-device-posture-rule parameters: - in: path name: rule_id required: true schema: $ref: '#/components/schemas/teams-devices_uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: {} required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_id_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Delete a device posture rule response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_id_response' description: Delete a device posture rule response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Delete a device posture rule tags: - Device Posture Rules x-api-token-group: - Teams Write get: description: Fetches a single device posture rule. operationId: device-posture-rules-device-posture-rules-details parameters: - in: path name: rule_id required: true schema: $ref: '#/components/schemas/teams-devices_uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Get device posture rule details response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_single_response' description: Get device posture rule details response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get device posture rule details tags: - Device Posture Rules x-api-token-group: - Teams Read - Teams Write put: description: Updates a device posture rule. operationId: device-posture-rules-update-device-posture-rule parameters: - in: path name: rule_id required: true schema: $ref: '#/components/schemas/teams-devices_uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: schema: properties: description: $ref: '#/components/schemas/teams-devices_description' expiration: $ref: '#/components/schemas/teams-devices_expiration' input: $ref: '#/components/schemas/teams-devices_input' match: $ref: '#/components/schemas/teams-devices_match' name: $ref: '#/components/schemas/teams-devices_name' schedule: $ref: '#/components/schemas/teams-devices_schedule' type: $ref: '#/components/schemas/teams-devices_type' required: - name - type required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Update a device posture rule response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_single_response' description: Update a device posture rule response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Update a device posture rule tags: - Device Posture Rules x-api-token-group: - Teams Write components: schemas: teams-devices_match: description: The conditions that the client must match to run the rule. items: $ref: '#/components/schemas/teams-devices_match_item' type: array teams-devices_result_info: properties: count: description: Total number of results for the requested service example: 1 type: number page: description: Current page within paginated list of results example: 1 type: number per_page: description: Number of results per page of results example: 20 type: number total_count: description: Total results available without any search parameters example: 2000 type: number type: object teams-devices_api-response-common-failure: properties: errors: allOf: - $ref: '#/components/schemas/teams-devices_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/teams-devices_messages' example: [] result: enum: - null nullable: true type: object success: description: Whether the API call was successful enum: - false example: false type: boolean required: - success - errors - messages - result type: object teams-devices_uuid: description: API UUID. example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 maxLength: 36 type: string teams-devices_checkDisks: description: List of volume names to be checked for encryption. example: - C - D - G items: type: string type: array teams-devices_os_version_input_request: properties: operating_system: description: Operating System enum: - windows example: windows type: string operator: description: Operator enum: - < - <= - '>' - '>=' - == example: 13.3.0 type: string os_distro_name: description: Operating System Distribution Name (linux only) example: ubuntu type: string os_distro_revision: description: Version of OS Distribution (linux only) example: 11.3.1 type: string os_version_extra: description: Additional version data. For Mac or iOS, the Product Verison Extra. For Linux, the kernel release version. (Mac, iOS, and Linux only) example: (a) or -1007 type: string version: description: Version of OS example: 13.3.0 type: string required: - operating_system - version - operator title: OS Version type: object teams-devices_firewall_input_request: properties: enabled: description: Enabled example: true type: boolean operating_system: description: Operating System enum: - windows - mac example: windows type: string required: - operating_system - enabled title: Firewall type: object teams-devices_expiration: description: Sets the expiration time for a posture check result. If empty, the result remains valid until it is overwritten by new data from the WARP client. example: 1h type: string teams-devices_sentinelone_input_request: properties: operating_system: description: Operating system enum: - windows - linux - mac example: mac type: string path: description: File path. example: /bin/cat type: string sha256: description: SHA-256. example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c type: string thumbprint: description: Signing certificate thumbprint. example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e type: string required: - path - operating_system title: Sentinelone type: object teams-devices_schedule: description: 'Polling frequency for the WARP client posture check. Default: `5m` (poll every five minutes). Minimum: `1m`.' example: 1h type: string teams-devices_disk_encryption_input_request: properties: checkDisks: $ref: '#/components/schemas/teams-devices_checkDisks' requireAll: $ref: '#/components/schemas/teams-devices_requireAll' title: Disk Encryption type: object teams-devices_api-response-collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-common' - properties: result: items: {} nullable: true type: array result_info: $ref: '#/components/schemas/teams-devices_result_info' type: object teams-devices_api-response-common: properties: errors: $ref: '#/components/schemas/teams-devices_messages' messages: $ref: '#/components/schemas/teams-devices_messages' result: anyOf: - type: object - items: {} type: array - type: string success: description: Whether the API call was successful. enum: - true example: true type: boolean required: - success - errors - messages - result type: object teams-devices_trust_stores_enum: enum: - system - user type: string teams-devices_identifier: example: 699d98642c564d2e855e9661899b7252 teams-devices_paths: description: List of paths to check for client certificate on linux. example: - /path1 - /path2 items: type: string type: array teams-devices_response_collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: items: $ref: '#/components/schemas/teams-devices_device-posture-rules' type: array teams-devices_client_certificate_v2_input_request: properties: certificate_id: description: UUID of Cloudflare managed certificate. example: b14ddcc4-bcd2-4df4-bd4f-eb27d5a50c30 maxLength: 36 type: string check_private_key: description: Confirm the certificate was not imported from another device. We recommend keeping this enabled unless the certificate was deployed without a private key. example: true type: boolean cn: description: Common Name that is protected by the client certificate. This may include one or more variables in the ${ } notation. Only ${serial_number} and ${hostname} are valid variables. example: ${hostname}.com.${serial_number} type: string extended_key_usage: description: List of values indicating purposes for which the certificate public key can be used example: - clientAuth - emailProtection items: $ref: '#/components/schemas/teams-devices_extended_key_usage_enum' type: array locations: properties: paths: $ref: '#/components/schemas/teams-devices_paths' trust_stores: $ref: '#/components/schemas/teams-devices_trust_stores' type: object operating_system: description: Operating System enum: - windows - mac - linux example: windows type: string required: - certificate_id - check_private_key - operating_system title: Client Certificate V2 type: object teams-devices_workspace_one_input_request: properties: compliance_status: description: Compliance Status enum: - compliant - noncompliant - unknown example: compliant type: string connection_id: description: Posture Integration ID. example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f type: string required: - connection_id - compliance_status title: Workspace One S2S Input type: object teams-devices_single_response: allOf: - $ref: '#/components/schemas/teams-devices_api-response-single' - properties: result: $ref: '#/components/schemas/teams-devices_device-posture-rules' teams-devices_match_item: properties: platform: $ref: '#/components/schemas/teams-devices_platform' type: object teams-devices_kolide_input_request: properties: connection_id: description: Posture Integration ID. example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f type: string countOperator: description: Count Operator enum: - < - <= - '>' - '>=' - == example: '>' type: string issue_count: description: The Number of Issues. example: 1 type: string required: - connection_id - countOperator - issue_count title: Kolide S2S Input type: object teams-devices_custom_s2s_input_request: properties: connection_id: description: Posture Integration ID. example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f type: string operator: description: operator enum: - < - <= - '>' - '>=' - == example: '>' type: string score: description: A value between 0-100 assigned to devices set by the 3rd party posture provider. example: 100 type: number required: - connection_id - score - operator title: Custom Device Posture Integration Input type: object teams-devices_type: description: The type of device posture rule. enum: - file - application - tanium - gateway - warp - disk_encryption - sentinelone - carbonblack - firewall - os_version - domain_joined - client_certificate - client_certificate_v2 - unique_client_id - kolide - tanium_s2s - crowdstrike_s2s - intune - workspace_one - sentinelone_s2s - custom_s2s example: file type: string teams-devices_tanium_input_request: properties: connection_id: description: Posture Integration ID. example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f type: string eid_last_seen: description: For more details on eid last seen, refer to the Tanium documentation. example: '2023-07-20T23:16:32Z' type: string operator: description: Operator to evaluate risk_level or eid_last_seen. enum: - < - <= - '>' - '>=' - == example: '>' type: string risk_level: description: For more details on risk level, refer to the Tanium documentation. enum: - low - medium - high - critical example: low type: string scoreOperator: description: Score Operator enum: - < - <= - '>' - '>=' - == example: '>' type: string total_score: description: For more details on total score, refer to the Tanium documentation. example: 1 type: number required: - connection_id title: Tanium S2S Input type: object teams-devices_crowdstrike_input_request: properties: connection_id: description: Posture Integration ID. example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f type: string last_seen: description: For more details on last seen, please refer to the Crowdstrike documentation. example: 15d3h20m4s type: string operator: description: Operator enum: - < - <= - '>' - '>=' - == example: '>' type: string os: description: Os Version example: 13.3.0 type: string overall: description: overall example: 90 type: string sensor_config: description: SensorConfig example: 90 type: string state: description: For more details on state, please refer to the Crowdstrike documentation. enum: - online - offline - unknown example: online type: string version: description: Version example: 13.3.0 type: string versionOperator: description: Version Operator enum: - < - <= - '>' - '>=' - == example: '>' type: string required: - connection_id title: Crowdstrike S2S Input type: object teams-devices_file_input_request: properties: exists: description: Whether or not file exists example: true type: boolean operating_system: description: Operating system enum: - windows - linux - mac example: mac type: string path: description: File path. example: /bin/cat type: string sha256: description: SHA-256. example: https://api.us-2.crowdstrike.com type: string thumbprint: description: Signing certificate thumbprint. example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e type: string required: - path - operating_system title: File Check type: object teams-devices_id_response: allOf: - $ref: '#/components/schemas/teams-devices_api-response-single' - properties: result: properties: id: $ref: '#/components/schemas/teams-devices_uuid' type: object teams-devices_sentinelone_s2s_input_request: properties: active_threats: description: The Number of active threats. example: 1 type: number connection_id: description: Posture Integration ID. example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f type: string infected: description: Whether device is infected. example: true type: boolean is_active: description: Whether device is active. example: true type: boolean network_status: description: Network status of device. enum: - connected - disconnected - disconnecting - connecting example: connected type: string operator: description: operator enum: - < - <= - '>' - '>=' - == example: '>' type: string required: - connection_id title: SentinelOne S2S Input type: object teams-devices_description: description: The description of the device posture rule. example: The rule for admin serial numbers type: string teams-devices_platform: enum: - windows - mac - linux - android - ios example: windows type: string teams-devices_requireAll: description: Whether to check all disks for encryption. example: true type: boolean teams-devices_intune_input_request: properties: compliance_status: description: Compliance Status enum: - compliant - noncompliant - unknown - notapplicable - ingraceperiod - error example: compliant type: string connection_id: description: Posture Integration ID. example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f type: string required: - connection_id - compliance_status title: Intune S2S Input type: object teams-devices_domain_joined_input_request: properties: domain: description: Domain example: example.com type: string operating_system: description: Operating System enum: - windows example: windows type: string required: - operating_system title: Domain Joined type: object teams-devices_carbonblack_input_request: properties: operating_system: description: Operating system enum: - windows - linux - mac example: mac type: string path: description: File path. example: /bin/cat type: string sha256: description: SHA-256. example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c type: string thumbprint: description: Signing certificate thumbprint. example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e type: string required: - path - operating_system title: Carbonblack type: object teams-devices_device-posture-rules: properties: description: $ref: '#/components/schemas/teams-devices_description' expiration: $ref: '#/components/schemas/teams-devices_expiration' id: $ref: '#/components/schemas/teams-devices_uuid' input: $ref: '#/components/schemas/teams-devices_input' match: $ref: '#/components/schemas/teams-devices_match' name: $ref: '#/components/schemas/teams-devices_name' schedule: $ref: '#/components/schemas/teams-devices_schedule' type: $ref: '#/components/schemas/teams-devices_type' type: object teams-devices_api-response-single: allOf: - $ref: '#/components/schemas/teams-devices_api-response-common' - properties: result: anyOf: - type: object - type: string nullable: true type: object type: object teams-devices_client_certificate_input_request: properties: certificate_id: description: UUID of Cloudflare managed certificate. example: b14ddcc4-bcd2-4df4-bd4f-eb27d5a50c30 maxLength: 36 type: string cn: description: Common Name that is protected by the certificate example: example.com type: string required: - certificate_id - cn title: Client Certificate type: object teams-devices_unique_client_id_input_request: properties: id: description: List ID. example: da3de859-8f6e-47ea-a2b5-b2433858471f type: string operating_system: description: Operating System enum: - android - ios - chromeos example: android type: string required: - operating_system - id title: Unique Client ID type: object teams-devices_extended_key_usage_enum: enum: - clientAuth - emailProtection type: string teams-devices_input: description: The value to be checked against. example: operating_system: linux path: /bin/cat thumbprint: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e oneOf: - $ref: '#/components/schemas/teams-devices_file_input_request' - $ref: '#/components/schemas/teams-devices_unique_client_id_input_request' - $ref: '#/components/schemas/teams-devices_domain_joined_input_request' - $ref: '#/components/schemas/teams-devices_os_version_input_request' - $ref: '#/components/schemas/teams-devices_firewall_input_request' - $ref: '#/components/schemas/teams-devices_sentinelone_input_request' - $ref: '#/components/schemas/teams-devices_carbonblack_input_request' - $ref: '#/components/schemas/teams-devices_disk_encryption_input_request' - $ref: '#/components/schemas/teams-devices_application_input_request' - $ref: '#/components/schemas/teams-devices_client_certificate_input_request' - $ref: '#/components/schemas/teams-devices_client_certificate_v2_input_request' - $ref: '#/components/schemas/teams-devices_workspace_one_input_request' - $ref: '#/components/schemas/teams-devices_crowdstrike_input_request' - $ref: '#/components/schemas/teams-devices_intune_input_request' - $ref: '#/components/schemas/teams-devices_kolide_input_request' - $ref: '#/components/schemas/teams-devices_tanium_input_request' - $ref: '#/components/schemas/teams-devices_sentinelone_s2s_input_request' - $ref: '#/components/schemas/teams-devices_custom_s2s_input_request' type: object teams-devices_application_input_request: properties: operating_system: description: Operating system enum: - windows - linux - mac example: mac type: string path: description: Path for the application. example: /bin/cat type: string sha256: description: SHA-256. example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c type: string thumbprint: description: Signing certificate thumbprint. example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e type: string required: - path - operating_system title: Application type: object teams-devices_messages: example: [] items: properties: code: minimum: 1000 type: integer message: type: string required: - code - message type: object uniqueItems: true type: array teams-devices_trust_stores: description: List of trust stores to check for client certificate. example: - system - user items: $ref: '#/components/schemas/teams-devices_trust_stores_enum' type: array teams-devices_name: description: The name of the device posture rule. example: Admin Serial Numbers type: string securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true