Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Device Posture Rules API

The Device Posture Rules API from APIs.io Engineering Platform — 2 operation(s) for device posture rules.

This API exposes 5 operations across 2 paths, and defines 45 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

5 operations 2 paths 45 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Device Posture Rules API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Device Posture Rules 5
GET
/accounts/{account_id}/devices/posture
APIs.io Engineering Platform List device posture rules
device-posture-rules-list-device-posture-rules 1 param → 4XX200
POST
/accounts/{account_id}/devices/posture
APIs.io Engineering Platform Create a device posture rule
device-posture-rules-create-device-posture-rule 1 param body → 4XX200
DELETE
/accounts/{account_id}/devices/posture/{rule_id}
APIs.io Engineering Platform Delete a device posture rule
device-posture-rules-delete-device-posture-rule 2 params body → 4XX200
GET
/accounts/{account_id}/devices/posture/{rule_id}
APIs.io Engineering Platform Get device posture rule details
device-posture-rules-device-posture-rules-details 2 params → 4XX200
PUT
/accounts/{account_id}/devices/posture/{rule_id}
APIs.io Engineering Platform Update a device posture rule
device-posture-rules-update-device-posture-rule 2 params body → 4XX200

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are teams-devices_crowdstrike_input_request (9 properties), teams-devices_device-posture-rules (8 properties), teams-devices_os_version_input_request (6 properties), teams-devices_client_certificate_v2_input_request (6 properties). Each schema is shown below with its type and property counts.

teams-devices_match
array
The conditions that the client must match to run the rule.
teams-devices_result_info
object
4 properties
teams-devices_api-response-common-failure
object
4 properties 4 required
teams-devices_uuid
string
API UUID.
teams-devices_checkDisks
array
List of volume names to be checked for encryption.
teams-devices_os_version_input_request
object
6 properties 3 required
teams-devices_firewall_input_request
object
2 properties 2 required
teams-devices_expiration
string
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.
teams-devices_sentinelone_input_request
object
4 properties 2 required
teams-devices_schedule
string
Polling frequency for the WARP client posture check. Default: 5m (poll every five minutes). Minimum: 1m.
teams-devices_disk_encryption_input_request
object
2 properties
teams-devices_api-response-collection
object
teams-devices_api-response-common
object
4 properties 4 required
teams-devices_trust_stores_enum
string
teams-devices_identifier
teams-devices_paths
array
List of paths to check for client certificate on linux.
teams-devices_response_collection
teams-devices_client_certificate_v2_input_request
object
6 properties 3 required
teams-devices_workspace_one_input_request
object
2 properties 2 required
teams-devices_single_response
teams-devices_match_item
object
1 property
teams-devices_kolide_input_request
object
3 properties 3 required
teams-devices_custom_s2s_input_request
object
3 properties 3 required
teams-devices_type
string
The type of device posture rule.
teams-devices_tanium_input_request
object
6 properties 1 required
teams-devices_crowdstrike_input_request
object
9 properties 1 required
teams-devices_file_input_request
object
5 properties 2 required
teams-devices_id_response
teams-devices_sentinelone_s2s_input_request
object
6 properties 1 required
teams-devices_description
string
The description of the device posture rule.
teams-devices_platform
string
teams-devices_requireAll
boolean
Whether to check all disks for encryption.
teams-devices_intune_input_request
object
2 properties 2 required
teams-devices_domain_joined_input_request
object
2 properties 1 required
teams-devices_carbonblack_input_request
object
4 properties 2 required
teams-devices_device-posture-rules
object
8 properties
teams-devices_api-response-single
object
teams-devices_client_certificate_input_request
object
2 properties 2 required
teams-devices_unique_client_id_input_request
object
2 properties 2 required
teams-devices_extended_key_usage_enum
string
teams-devices_input
object
The value to be checked against.
teams-devices_application_input_request
object
4 properties 2 required
teams-devices_messages
array
teams-devices_trust_stores
array
List of trust stores to check for client certificate.
teams-devices_name
string
The name of the device posture rule.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-device-posture-rules-api-openapi.yml Raw ↑