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.

Generate Flightdeck API access token

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:

The required client_id and client_secret are created by an admin via the dope console.
Returned access tokens are valid for a limited time period. Clients must check the expires_in value in the response to generate a new access token before the current one expires.
The OAuth scopes parameter is not supported and if provided will be ignored. The scopes returned in the access token are set directly by the authorization server.

POSThttps://api.flightdeck.dope.security/v1/partner/oauth/token

Body

grant_type*enum

The type of grant requested. You must set this to client_credentials

client_credentials

client_id*string

Your application's Client ID.

client_secret*string

Your application's Client Secret.

Response

Body

access_token*string

The new access token.

Example: "eyJz93a...k4laUWw"

token_type*enum

The type of token returned.

bearer

expires_in*number

The expiration time of the new access token in seconds.

Example: 3600

Request

const response = await fetch('https://api.flightdeck.dope.security/v1/partner/oauth/token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "grant_type": "client_credentials",
      "client_id": "text",
      "client_secret": "text"
    }),
});
const data = await response.json();

Response

{
  "access_token": "eyJz93a...k4laUWw",
  "token_type": "bearer",
  "expires_in": 3600
}

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

Use this API to get a list of all endpoints, or search for those matching a query parameter.

Note:

To return a list of all endpoints do not include any additional parameter.
Only one of the optional parameters is allowed to be specified per request.
Results are returned in pages using cursor based pagination and ordered by the lastSeen property.

GEThttps://api.flightdeck.dope.security/v1/endpoints/search

Authorization

Query parameters

Response

Body

dataobject

Request

const response = await fetch('https://api.flightdeck.dope.security/v1/endpoints/search', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "data": {
    "pageInfo": {
      "endCursor": "text",
      "hasNextPage": false
    },
    "endpoints": [
      {
        "agentUUID": "10e68510c-0885-4943-a8b0-b6feb29a9f81",
        "userUUID": "24c38805-1289-44fa-b974-2071a1702ba9",
        "agentVersion": "1.0.00000",
        "binaryType": "x86",
        "cityName": "Cork",
        "region": "Munster",
        "countryName": "Ireland",
        "cpuFamily": "Apple M1 Max",
        "debugState": "1",
        "deviceName": "Dope-MacBook-Pro.local",
        "disableMode": false,
        "errorMessage": "Agent is not running.",
        "fallbackMode": false,
        "configurationLastUpdated": "2023-10-10T10:10:00-0000",
        "osVersion": "Mac13",
        "policyName": "Base Policy",
        "realtimeConnection": true,
        "status": "healthy",
        "lastSeen": "2023-10-10T10:10:00-0000",
        "userId": "dope-user",
        "emailId": "givenName.familyName@dope.security"
      }
    ]
  }
}

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'

Add URLs to a Custom Category

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.

POSThttps://api.flightdeck.dope.security/v1/custom_categories/{custom_category_name}/urls

Authorization

Path parameters

custom_category_name*string

The name of the custom category to add URLs to

Body

dataobject

Response

Request

const response = await fetch('https://api.flightdeck.dope.security/v1/custom_categories/{custom_category_name}/urls', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

[
  {
    "message": "text",
    "details": "text"
  }
]

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 a specific URL from a Custom Category

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.

DELETEhttps://api.flightdeck.dope.security/v1/custom_categories/{custom_category_name}/url/{encoded_url}

Authorization

Path parameters

custom_category_name*string

The name of the custom category to delete given URL from

encoded_url*string

The URL to be deleted (Ensure that URLs are properly URL-encoded using the UTF8 encoding method)

Example: "https%3A%2F%2Fdope.security"

Response

Request

const response = await fetch('https://api.flightdeck.dope.security/v1/custom_categories/{custom_category_name}/url/{encoded_url}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

[
  {
    "message": "text",
    "details": "text"
  }
]

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 All URLs from a Custom Category

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.

DELETEhttps://api.flightdeck.dope.security/v1/custom_categories/{custom_category_name}/urls

Authorization

Path parameters

custom_category_name*string

The name of the custom category to delete all URLs from

Response

Request

const response = await fetch('https://api.flightdeck.dope.security/v1/custom_categories/{custom_category_name}/urls', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

[
  {
    "message": "text",
    "details": "text"
  }
]

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'

List all URLs of a Custom Category

Use this API to get all URLs of an existing custom category.

GEThttps://api.flightdeck.dope.security/v1/custom_categories/{custom_category_name}/urls

Authorization

Path parameters

custom_category_name*string

The name of the custom category to get URLs from

Response

Body

data*object

Request

const response = await fetch('https://api.flightdeck.dope.security/v1/custom_categories/{custom_category_name}/urls', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "data": {
    "urls": [
      "dope.security",
      "google.com"
    ]
  }
}

curl -X 'GET' \
  'https://api.flightdeck.dope.security/v1/custom_categories/some_category_name/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.

PreviousRelease Notes

Last updated 2 months ago