Public API Specification
Last updated
Last updated
Welcome to the Flightdeck API by dope.security
. Modify custom categories, get endpoint statuses, and more via API! Stay tuned for upcoming updates that will enhance the capabilities and features of this API.
For details on how to create API client credentials please see API Client Credentials.
We have provided our partner .yaml file below, available for download. This can be used with API tools like Swagger, Postman, etc.
Use this API to generate an access token for use with the Flightdeck API. A valid access token returned from this API is required in all other Flightdeck API calls.
Token generation is based on the OAuth 2.0 Client Credentials Flow. The returned token is used within the HTTP Authorization header as follows:
Authorization: Bearer <access token>
Note:
client_id
and client_secret
are created by an admin via the dope console.expires_in
value in
the response to generate a new access token before the current one expires./partner/oauth/token
Your application's Client ID.
Your application's Client Secret.
The type of grant requested. You must set this to client_credentials
client_credentials
Use this API to get a list of all endpoints, or search for those matching a query parameter.
Note:
lastSeen
property./endpoints/search
Broad search query across endpoints by device, user and email identities that contain this string (case-insensitive)
Search by email ids that contain this string (case-insensitive)
Search by device names that contain this string (case-insensitive)
Search by user ids that contain this string (case-insensitive). userId
for OIDC users is usually their email address.
Filter by this exact device OS version string
Filter by this exact set of status'
Filter by this exact set of debug states. 0 means not in debug 1 means debug request sent to endpoint 2 means debug request acknowledged by endpoint
Filter by the fallback mode
true
, false
Filter by this exact location id - with an underscore separating the case sensitive city and country values e.g. "City_Country"
Filter by this exact agent version
An optional pagination param that states the number of records requested from the start of the cursor
.
An optional pagination param that contains the current cursor
and indicates that records after the current cursor are requested.
The direction of the sort by the lastSeen
property. The default is to sort by descending
desc
, asc
Use this API to get all URLs of an existing custom category.
/custom_categories/{custom_category_name}/urls
The name of the custom category to get URLs from
Use this API to add URLs to an existing custom category.
Specify the name of the custom category in the path parameter (custom_category_name
)
and provide a JSON array of URLs in the request body.
Ensure that URLs are properly formatted and included in the array.
/custom_categories/{custom_category_name}/urls
The name of the custom category to add URLs to
No body
Use this API to delete a specific URL from an existing custom category.
Specify the name of the custom category in the path parameter (custom_category_name
).
Ensure that a given URL is encoded using URL encoding.
/custom_categories/{custom_category_name}/url/{encoded_url}
The name of the custom category to delete given URL from
The URL to be deleted (Ensure that URLs are properly URL-encoded using the UTF8 encoding method)
https%3A%2F%2Fdope.security
No body
Use this API to delete all URLs from an existing custom category.
Specify the name of the custom category in the path parameter (custom_category_name
).
This action will remove all URLs associated with the specified custom category.
/custom_categories/{custom_category_name}/urls
The name of the custom category to delete all URLs from
No body