logo
Documentation Powered by ReDoc

Honeycomb API (1.0.0)

Download OpenAPI specification:Download

Terms of Service

The Scoutbees Honeycomb API gives you access to pretty much all the features you can use on the app and lets you extend them for use in your application. It strives to be RESTful and is organized around the main resources you would be interacting with - such as Scouts, Tests and Hives.

Authentication

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: x-scoutbees-key

Scouts

The Scout API allows you create and manage Scouts on your account.

Get list of Scouts

List Scouts available on your account.

Authorizations:
ApiKeyAuth (read)
query Parameters
Cloud Hive Name (string) or Custom Hive ID (integer)

Filter Scouts by Cloud Hive Name (eu-central-1, us-east-1, ap-southeast-2) or Custom Hive ID (eg. 3535).

type
string
Enum: "network" "euc"

Filter by Scout type (EUC/Network).

subType
string
Enum: "vmware_horizon" "vmware_w1" "vmware_secsrv" "citrix_gateway" "citrix_cloud" "citrix_storefront" "net_ping" "net_dns" "net_traceroute" "net_http" "net_siteload"

Filter by Scout's sub-type (e.g. Citrix Virtual Apps and Desktops - Netscaler, VMware Horizon Connection Server).

interval
integer

Filter by Scout's configured interval.

disabled
boolean
Default: 0
Enum: 0 1

Filter by Scout's status.

username
string

Filter by Scout's credentials username (EUC scouts only).

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "total_pages": 1,
  • "success": true,
  • "total": 2,
  • "data": [
    ]
}

Create new scout

Create a Scout on your account.

Authorizations:
ApiKeyAuth (write)
Request Body schema: application/json

Required parameters to create a Scout -

One of
One of
required
Cloud hive name (string) or Custom hive id (integer)
subType
required
string
Value: "citrix_gateway"

Type of platform to run scouts

address
required
string <url>

Gateway address

scoutName
required
string

Scout name

interval
required
integer
Enum: 5 10 15 30 60

Scout interval (minutes)

resource
required
string

Published resource to test

username
required
string

Username for gateway authentication

password
required
string

Password for gateway authentication

object or null (OTP)

Single-step two-Factor authentication method

object (EucExtras)

Additional parameters

Responses

Request samples

Content type
application/json
Example
Create EUC Scout
Create EUC Scout
Create Network Scout
{
  • "hive": "eu-central-1",
  • "subType": "citrix_gateway"
}

Response samples

Content type
application/json
{
  • "message": "Scout has been created."
}

Get Scout Summary

Return a scout's details and its summary.

Authorizations:
ApiKeyAuth (read)
path Parameters
scoutId
required
integer

Scout ID

query Parameters
start
string <date-time>
Example: start=2021-01-01 13:21:55

Start date of the search

end
string <date-time>
Example: end=2021-02-01 10:24:55

End date of the search

Responses

Response samples

Content type
application/json
Example
Citrix (EUC) scout example
Citrix (EUC) scout example
Traceroute (Net) scout example
{
  • "success": true,
  • "data": {
    },
  • "summary": {
    }
}

Edit scout by id

Edit existing scout.

Authorizations:
ApiKeyAuth (write)
path Parameters
scoutId
required
integer

Scout ID

Request Body schema: application/json

Edit scout

One of
hive
string
Enum: "eu-central-1" "us-east-1" "ap-southeast-2" "norwayeast" "eastasia" "southindia" "westus2"

Scout running on cloud hive, it can be moved to different cloud hive

domain
string

Exists only in those subTypes: citrix_cloud, vmware_horizon, vmware_secsrv

address
string <url>

Gateway address

scoutName
string

Scout name

interval
integer
Enum: 5 10 15 30 60

Scout interval (minutes)

resource
string

Published resource to test

username
string

Username for gateway authentication

password
string

Password for gateway authentication

object or null (OTP)

Single-step two-Factor authentication method

object (EucExtras)

Additional parameters

Responses

Request samples

Content type
application/json
Example
Edit EUC Scout
Edit EUC Scout
Edit Network Scout
{
  • "hive": "eu-central-1",
  • "domain": "string",
  • "address": "string",
  • "scoutName": "string",
  • "interval": 5,
  • "resource": "string",
  • "username": "string",
  • "password": "string",
  • "otp": {
    },
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Delete scout by id

Delete existing scout.

Authorizations:
ApiKeyAuth (write)
path Parameters
scoutId
required
integer

Scout ID

Request Body schema: application/json
force
boolean

use this option to forcefully remove scout

Responses

Request samples

Content type
application/json
{
  • "force": true
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Enable/disable scout by id

Enable/disable scout.

Authorizations:
ApiKeyAuth (write)
path Parameters
scoutId
required
integer

Scout ID

Request Body schema: application/json
disabled
required
boolean

set to true to disable a scout, set to false to enable a scout

force
boolean

use this option to forcefully remove scout

Responses

Request samples

Content type
application/json
{
  • "disabled": true,
  • "force": true
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Tests

The output of the scout tests

Get list of scouts' tests

List of tests.

Authorizations:
ApiKeyAuth (read)
query Parameters
start
string <date-time>
Example: start=2021-01-01 13:21:55

Start date of the search

end
string <date-time>
Example: end=2021-02-01 10:24:55

End date of the search

scoutId
Array of integers
Example: scoutId=1,2

Provide scouts' id, if missing it will return tests of all scouts.

status
string
Enum: "success" "failure"
Example: status=success

Filter by test status.

page
integer

Each page shows up to 100 items.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 0,
  • "total_pages": 0,
  • "total_per_page": 100,
  • "success": true,
  • "total": 0
}

Hives

The Hives API allows you create and manage Hives on your account.

Get list of Custom Hives

Organization's active custom hives

Authorizations:
ApiKeyAuth (read)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true
}