Search
K
Links
Comment on page

Public API Specification

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.
post
https://api.flightdeck.dope.security/v1
/partner/oauth/token
Generate Flightdeck API access token

Generate Flightdeck API access tokens - Example

curl -X 'POST' \
'https://api.flightdeck.dope.security/v1/partner/oauth/token' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"grant_type": "client_credentials",
"client_id": "string",
"client_secret": "string"
}'

List and Search Endpoints - Examples

List all endpoints

curl -X 'GET' \
'https://api.flightdeck.dope.security/v1/endpoints/search' \
-H 'accept: application/json' \
-H 'Authorization: Bearer access_token'

Search by email address

curl -X 'GET' \
'https://api.flightdeck.dope.security/v1/endpoints/search?emailId=string' \
-H 'accept: application/json' \
-H 'Authorization: Bearer access_token'
post
https://api.flightdeck.dope.security/v1
/custom_categories/{custom_category_name}/urls
Add URLs to a Custom Category

Add URLs to a Custom Category - Example

curl -X 'POST' \
'https://api.flightdeck.dope.security/v1/custom_categories/string/urls' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer access_token'
-d '{
"data": {
"urls": [
"dope.security",
"google.com"
]
}
}'
delete
https://api.flightdeck.dope.security/v1
/custom_categories/{custom_category_name}/url/{encoded_url}
Delete a specific URL from a Custom Category

Delete a specific URL from a Custom Category - Example

curl -X 'DELETE' \
'https://api.flightdeck.dope.security/v1/custom_categories/some_category_name/url/url_encoded_string' \
-H 'accept: */*' \
-H 'Authorization: Bearer access_token'
delete
https://api.flightdeck.dope.security/v1
/custom_categories/{custom_category_name}/urls
Delete All URLs from a Custom Category

Delete All URLs from a Custom Category

curl -X 'DELETE' \
'https://api.flightdeck.dope.security/v1/custom_categories/string/urls' \
-H 'accept: */*' \
-H 'Authorization: Bearer access_token'

We have provided our partner .yaml file below, available for download. This can be used with API tools like Swagger, Postman, etc.
partner_api_1.0.1.yaml
19KB
Code
Partner YAML file
Last modified 1d ago