The Foxpass Developer Hub

Welcome to the Foxpass developer hub. You'll find comprehensive guides and documentation to help you start working with Foxpass as quickly as possible, as well as support if you get stuck.

Get Started    API Reference
Suggest Edits

API Overview

 

Foxpass offers an API to view and manage directory data and other settings. The API is useful for integrating with any custom tools you use or for automating certain tasks. To read more about the API endpoints and specifications, just read below. If there's an endpoint or feature you'd like to see supported, just email us at help@foxpass.com.

NOTE: If you're using Windows, substitute double quotes " instead of single quotes ' in the examples provided below.

Suggest Edits

How To Use The 'Try It' Feature

 

You can use the API explorer to quickly test out API endpoints, or even perform simple modifications of your data.

1. Get an API Key

Create an API key on the 'API Keys' page. Note: the API explorer is hitting the live Foxpass site, so if you're worried about messing with your data mark your key as "Read Only" in the Foxpass console. You should also be careful about transmitting sensitive data through our 3rd party docs host, ReadMe.

2. Input the API Key

Click on the icon to the left of the 'Try It' button and paste in your API key.

3. Try it out!

Enter in any parameters underneath the example and click the orange 'Try It!' button to call the API. Required parameters are marked with a red asterisk.

This feature does not work on /my/sshkeys/

You must specify email and password in the header to authenticate for that endpoint.

Suggest Edits

/users/

Get list of all users

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/users/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/users/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": [{"username": "aren", "is_eng_user": true, "gid": 1001, "uid": 1001, "last_name": "Sandersen", "github_username": "", "active": true, "shell": null, "first_name": "Aren"}, {"username": "test", "is_eng_user": true, "gid": 1002, "uid": 1002, "last_name": "Tester", "github_username": null, "active": false, "shell": null, "first_name": "Test"}]}
 
Suggest Edits

/users/

Create a new user

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/users/
curl -H 'Authorization: Token API_KEY' -X POST -d '{"username": "newuser", "email": "newuser@domain.com"}' https://api.foxpass.com/v1/users/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Headers

username
string
required

username

email
string
required

email

send_email
boolean

sends an email with a link to set a Foxpass password for console logins, if necessary.

 
Suggest Edits

/users/:username/

Get properties of a single user

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/users/username/
curl -H 'Authorization: Token API_KEY'  https://api.foxpass.com/v1/users/aren/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": {"username": "aren", "is_eng_user": true, "is_posix_user": false, "gid": 1001, "uid": 1001, "last_name": "Sandersen", "github_username": "", "active": true, "shell": null, "first_name": "Aren"}}

Path Params

username
string
required

username

 
Suggest Edits

/users/:username/

Change properties of a single user

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.foxpass.com/v1/users/username/
curl -H 'Authorization: Token API_KEY' -X PUT -d '{"is_eng_user": true}' https://api.foxpass.com/v1/users/aren/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Path Params

username
string
required

username

Body Params

first_name
string

first name

last_name
string

last name

github_username
string

github username

password
string

password

is_eng_user
boolean

is an engineering user with UNIX access

is_posix_user
boolean

is a user that has Posix info. NOTE: if is_eng_user is set to 'true' this value is ignored

is_active
boolean

is active and allowed to access LDAP & RADIUS

custom_fields
object

JSON object with keys as custom fields

 
uid
int32

uid value

gid
int32

gid value

shell
string

default shell

 

Valid fields are 'first_name', 'last_name', 'password', 'is_eng_user', 'github_username', 'is_active'

Suggest Edits

/users/:username/

Delete a single user

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.foxpass.com/v1/users/username/
curl -H 'Authorization: Token API_KEY' -X DELETE https://api.foxpass.com/v1/users/aren/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Path Params

username
string
required
 

Valid fields are 'first_name', 'last_name', 'password', 'is_eng_user', 'github_username', 'is_active'

Suggest Edits

/users/:username/sshkeys/

Get SSH keys for a given user

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/users/username/sshkeys/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/users/aren/sshkeys/ 
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": [{"name": "Aren's MacBook", "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDiMvwph/GSUmcuQbExkWcDAyA43iQwkUadbzhxPk7hQ7LkHaHYYtXLNkZqTSkcU001R+dUZGVlszmDza4eCbdOUqNsPwZFMleGoK1bp6pxoHK1DCdi2Mtf6JdCOrEdHyBVkyqn1eu/35SAt5X0wRKlVCueW1fA1sBgx0wcM/b4gtKV8MlpAS/Ax+A6y4l"}]}

Path Params

username
string
required

username

 
Suggest Edits

/users/:username/sshkeys/

Add a new SSH key

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/users/username/sshkeys/
curl -H 'Authorization: Token API_KEY' -X POST -d '{"name": "New Key", "key": "ssh-rsa AAAA0000111122223333"}' https://api.foxpass.com/v1/users/aren/sshkeys/ 
A binary file was returned

You couldn't be authenticated

{"status": "ok"}
{"status": "error", "message": "Bad key"}

Path Params

username
string
required

username

Body Params

name
string
required

key name

key
string
required

ssh keyy

 
Suggest Edits

/users/:username/sshkeys/:sshkey/

Modify an SSH key

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.foxpass.com/v1/users/username/sshkeys/sshkey/
curl -H 'Authorization: Token API_KEY' -X PUT -d '{"is_active": false}' https://api.foxpass.com/v1/users/aren/sshkeys/work_key/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}
{"status": "error", "message": "Bad key"}

Path Params

username
string
required

username

sshkey
string
required

key name

Body Params

is_active
boolean
required
 
Suggest Edits

/users/:username/sshkeys/:sshkey/

Modify an SSH key

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.foxpass.com/v1/users/username/sshkeys/sshkey/
curl -H 'Authorization: Token API_KEY' -X DELETE https://api.foxpass.com/v1/users/aren/sshkeys/work_key/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}
{"status": "error", "message": "Bad key"}

Path Params

username
string
required

username

sshkey
string
required

key name

 
Suggest Edits

/users/:username/groups/

Get group membership info for a given user

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/users/username/groups/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/users/aren/groups/ 
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": [{"expires": null, "name": "engineers"}, {"expires": "2015-11-10T00:04:37Z", "name": "sudo"}]}

Path Params

username
string
required

username

 
Suggest Edits

/users/:username/groups/

Add user to a group

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/users/username/groups/
curl -H 'Authorization: Token API_KEY' -X POST -d '{"name": "engineers"}' https://api.foxpass.com/v1/users/aren/groups/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Path Params

username
string
required

username

Body Params

name
string
required

group name

 
Suggest Edits

/users/:username/groups/:groupname/

Check if a user is in a group

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/users/username/groups/groupname/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/users/aren/groups/engineers/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": {"username": "aren", "expires": null}}

Path Params

username
string
required

username

groupname
string
required

group name

 
Suggest Edits

/users/:username/groups/:groupname/

Remove a user from a group

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.foxpass.com/v1/users/username/groups/groupname/
curl -H 'Authorization: Token API_KEY' -X DELETE https://api.foxpass.com/v1/users/aren/groups/engineers/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Path Params

username
string
required

username

groupname
string
required

group name

 
Suggest Edits

/groups/

Get list of all groups

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/groups/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/groups/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": [{"gid": 501, "name": "engineers"}, {"gid": 502, "name": "sudo"},{"gid": 503, "name": "wheel"}]
 
Suggest Edits

/groups/

Add a group

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/groups/
curl -H 'Authorization: Token API_KEY' -X POST -d '{"name": "mygroup", "gid": 510, "is_posix_group": false}' https://api.foxpass.com/v1/groups/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Body Params

name
string

Group name

gid
int32

GID for this group

is_posix_group
boolean

If this group should be returned to posix machines (Linux and Mac OS)

 
Suggest Edits

/groups/:groupname/

Get info for a group

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/groups/groupname/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/groups/engineers/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": {"gid": 501, "name": "engineers"}}

Path Params

groupname
string
required

group name

 

Note that if group sync'ing is setup, the group will come right back.

Suggest Edits

/groups/:groupname/

Delete a group

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.foxpass.com/v1/groups/groupname/
curl -H 'Authorization: Token API_KEY' -X DELETE https://api.foxpass.com/v1/groups/engineers/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": {"username": "aren", "expires": null}}

Path Params

groupname
string
required

group name

 
Suggest Edits

/groups/:groupname/members/

Get members for a group

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/groups/groupname/members/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/groups/engineers/members/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": {"username": "aren", "expires": null}}

Path Params

groupname
string
required

group name

 
Suggest Edits

/groups/:groupname/members/

Add a member to a group

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/groups/groupname/members/
curl -H 'Authorization: Token API_KEY' -X POST -d '{"username": "aren"}' https://api.foxpass.com/v1/groups/engineers/members/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Path Params

groupname
string
required

group name

Body Params

username
string
required

username

expires
date

expiration of group membership. 'YYYY-MM-DDTHH:MMZ' format

 
Suggest Edits

/groups/:groupname/members/:username/

Check if a member is in a group

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/groups/groupname/members/username/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/groups/engineers/members/aren/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": {"username": "aren", "expires": null}}

Path Params

groupname
string
required

group name

username
string
required

user name

 
Suggest Edits

/groups/:groupname/members/:username/

Remove a member from a group

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.foxpass.com/v1/groups/groupname/members/username/
curl -H 'Authorization: Token API_KEY' -X DELETE https://api.foxpass.com/v1/groups/engineers/members/aren/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Path Params

groupname
string
required

group name

username
string
required

user name

 
Suggest Edits

Host Groups

 
Suggest Edits

/hostgroups/

Get list of all host groups

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/hostgroups/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/hostgroups/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": [{"name": "prod"}, {"name": "test"}, {"name": "dev"}]
 
Suggest Edits

/hostgroups/:hostgroupname/

Get info for a host group

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/hostgroups/hostgroupname/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/hostgroups/prod/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": {"name": "prod"}}

Path Params

hostgroupname
string
required

host group name

 

Note that if group sync'ing is setup, the group will come right back.

Suggest Edits

/hostgroups/:hostgroupname/

Set info for a host group

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.foxpass.com/v1/hostgroups/hostgroupname/
curl -H 'Authorization: Token API_KEY' -X PUT -d '{"all_users": true}' https://api.foxpass.com/v1/hostgroups/prod/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Path Params

hostgroupname
string
required

host group name

Body Params

all_users
string

Allow all users access regardless of hostgroup membership status

 
Suggest Edits

/hostgroups/:hostgroupname/

Delete a host group

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.foxpass.com/v1/hostgroups/hostgroupname/
curl -H 'Authorization: Token API_KEY' -X DELETE https://api.foxpass.com/v1/hostgroups/prod/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Path Params

hostgroupname
string
required

host group name

 
Suggest Edits

/hostgroups/:hostgroupname/user_members/

Get user members for a host group

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/hotsgroups/hostgroupname/user_members/
curl -H 'Authorization: Token API_KEY'  https://api.foxpass.com/v1/hotsgroups/prod/user_members/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": {"username": "aren", "expires": null}}

Path Params

hostgroupname
string
required

host group name

 
Suggest Edits

/hostgroups/:hostgroupname/user_members/

Add a member to a host group

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/hostgroups/hostgroupname/user_members/
curl -H 'Authorization: Token API_KEY' -X POST -d '{"username": "aren"}' https://api.foxpass.com/v1/hostgroups/prod/user_members/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Path Params

hostgroupname
string
required

host group name

Body Params

username
string
required

username

expires
date

expiration of host group membership. 'YYYY-MM-DDTHH:MMZ' format

 
Suggest Edits

/hostgroups/:hostgroupname/user_members/:username/

Check if a member is in a host group

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/hostgroups/hostgroupname/user_members/username/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/hostgroups/prod/user_members/aren/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": {"username": "aren", "expires": null}}

Path Params

hostgroupname
string
required

host group name

username
string
required

user name

 
Suggest Edits

/hostgroups/:hostgroupname/user_members/:username/

Remove a user from a host group

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.foxpass.com/v1/hostgroups/hostgroupname/user_members/username/
curl -H 'Authorization: Token API_KEY' -X DELETE https://api.foxpass.com/v1/hostgroups/prod/user_members/aren/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Path Params

hostgroupname
string
required

host group name

username
string
required

user name

 
Suggest Edits

/hostgroups/:hostgroupname/group_members/

Get group members for a host group

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/hotsgroups/hostgroupname/group_members/
curl -H 'Authorization: Token API_KEY'  https://api.foxpass.com/v1/hotsgroups/prod/group_members/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": {"groupname": "sudo", "expires": null}}

Path Params

hostgroupname
string
required

host group name

 
Suggest Edits

/hostgroups/:hostgroupname/group_members/

Add a group to a host group

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/hostgroups/hostgroupname/group_members/
curl -H 'Authorization: Token API_KEY' -X POST -d '{"groupname": "sudo"}' https://api.foxpass.com/v1/hostgroups/prod/group_members/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Path Params

hostgroupname
string
required

host group name

Body Params

groupname
string
required

group name

expires
date

expiration of host group membership. 'YYYY-MM-DDTHH:MMZ' format

 
Suggest Edits

/hostgroups/:hostgroupname/group_members/:groupname/

Check if a group is a member of a host group

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/hostgroups/hostgroupname/group_members/:username/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/hostgroups/prod/group_members/sudo/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": {"groupname": "sudo", "expires": null}}

Path Params

hostgroupname
string
required

host group name

groupname
string
required

group name

 
Suggest Edits

/hostgroups/:hostgroupname/group_members/:groupname/

Remove a group from a host group

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.foxpass.com/v1/hostgroups/hostgroupname/user_members/:username/
curl -H 'Authorization: Token API_KEY' -X DELETE https://api.foxpass.com/v1/hostgroups/prod/group_members/sudo/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Path Params

hostgroupname
string
required

host group name

groupname
string
required

group name

 
 
Suggest Edits

/my/sshkeys/

Allows a user to get their own SSH keys

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/my/sshkeys/
curl -u 'email:password' https://api.foxpass.com/v1/my/sshkeys/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": [{"name": "Aren's MacBook", "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDiMvwph/GSUmcuQbExkWcDAyA43iQwkUadbzhxPk7hQ7LkHaHYYtXLNkZqTSkcU001R+dUZGVlszmDza4eCbdOUqNsPwZFMleGoK1bp6pxoHK1DCdi2Mtf6JdCOrEdHyBVkyqn1eu/35SAt5X0wRKlVCueW1fA1sBgx0wcM/b4gtKV8MlpAS/Ax+A6y4l"}]}
 

Used to check if access should be granted for a user to a resource. At least one value of "hostname" or "aws_instance_id" should be included. Both are not required.

The 'Try It' feature does not work for this endpoint

You must specify email and password in the header to authenticate.

Suggest Edits

/my/sshkeys/

Allows a user to add an SSH public key to their own account

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/my/sshkeys/
curl -u 'email:password' -X POST -d '{"name": "my new key", "key": "ssh-rsa AAAAA...."}' https://api.foxpass.com/v1/my/sshkeys/
A binary file was returned

You couldn't be authenticated

{'status': 'ok',
 'access': true}

Body Params

name
string
required

username

key
string
required

SSH public key, like "ssh-rsa AAAAAA....."

 

Used to check if access should be granted for a user to a resource. At least one value of "hostname" or "aws_instance_id" should be included. Both are not required.

The 'Try It' feature does not work for this endpoint

You must specify email and password in the header to authenticate.

Suggest Edits

Authentication

 
Suggest Edits

/authn/

Checks a username and password

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/authn/
curl -H 'Authorization: Token API_KEY' -X POST -d '{"username": "aren", "password": "mypassword"}' https://api.foxpass.com/v1/authn/
A binary file was returned

You couldn't be authenticated

{'status': 'ok'}

Body Params

username
string
required

username

password
string
required

password

 

Used to verify a correct name/password

Be Careful When Transmitting Passwords Through a 3rd Party

This endpoint is best used for testing purposes only.

Suggest Edits

/authz/

Check user access for a resource

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/authz/
curl -H 'Authorization: Token API_KEY' -X POST -d '{"username": "aren", "resource": {"hostname": "prod", "aws_instance_id": "i-XXXXXXXXX"}}' https://api.foxpass.com/v1/authz/
A binary file was returned

You couldn't be authenticated

{'status': 'ok',
 'access': true}

Body Params

username
string
required

username

resources
object
required

resources to check

 
 

Used to check if access should be granted for a user to a resource. At least one value of "hostname" or "aws_instance_id" should be included. Both are not required.

Be Careful When Transmitting Passwords Through a 3rd Party

This endpoint is best used for testing purposes only.

Suggest Edits

/logs/ldap/

Get LDAP logs

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/logs/ldap/
curl -H 'Authorization: Token API_KEY'  https://api.foxpass.com/v1/logs/ldap/ -d '{"from": "2016-02-08T02:30Z", "to": "2016-02-09T22:00Z", "ascending": true}'
A binary file was returned

You couldn't be authenticated

{'status': 'ok', 'page': 1, 'numPages': 7, 'data': [{'timestamp': '2016-02-08 17:22:08.000000', 'bindDn': 'cn=mybinder,dc=foxpass,dc=com', 'type': 'binder', 'success': true, 'message': 'Successful local auth'},...]}

Body Params

from
date
required

'YYYY-MM-DDTHH:MMZ' format

to
date
required

'YYYY-MM-DDTHH:MMZ' format

omit-success
boolean
omit-fail
boolean
ascending
boolean

return oldest logs first

page
int32
 

Returns up to 100 logs at a time. Downloading logs via the API is only available to customers who have subscribed to extended logging access

Note: Logs API access is an add-on feature

To enable this feature, contact us at help@foxpass.com

Suggest Edits

/logs/radius/

Get RADIUS logs

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/logs/radius/
curl -H 'Authorization: Token API_KEY'  https://api.foxpass.com/v1/logs/radius/ -d '{"from": "2016-02-08T02:30Z", "to": "2016-02-09T22:00Z", "ascending": true}'
A binary file was returned

You couldn't be authenticated

{'status': 'ok', 'page': 1, 'numPages': 7, 'data': [{'timestamp': '2016-02-08 17:22:08.000000', 'ipAddress': '127.0.0.1', 'username': 'aren', 'success': true, 'message': 'Password-only'},...]}

Body Params

from
date
required

'YYYY-MM-DDTHH:MMZ' format

to
date
required

'YYYY-MM-DDTHH:MMZ' format

omit-success
boolean
omit-fail
boolean
ascending
boolean

return oldest logs first

page
int32
 

Returns up to 100 logs at a time. Downloading logs via the API is only available to customers who have subscribed to extended logging access

Note: Logs API access is an add-on feature

To enable this feature, contact us at help@foxpass.com

Suggest Edits

/logs/event/

Get Event logs

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/logs/event/
curl -H 'Authorization: Token API_KEY'  https://api.foxpass.com/v1/logs/event/ -d '{"from": "2019-05-15T02:30Z", "to": "2019-05-16T22:00Z", "event_type": "user.set_admin"}'
A binary file was returned

You couldn't be authenticated

{"status": "ok", "page": 1 "numPages": 1, "data": [{"timestamp": "2019-05-15T20:16:19.361Z", "data": {"user": "aren@foxpass.com", "value": true, "actor": "richard@foxpass.com"}, "event_type": "user.set_admin"},...]}

Body Params

from
date
required

'YYYY-MM-DDTHH:MMZ' format

to
date
required

'YYYY-MM-DDTHH:MMZ' format

event_type
string
ascending
boolean

return oldest logs first

page
int32
 

Returns up to 100 logs at a time. Downloading logs via the API is only available to customers who have subscribed to extended logging access

Note: Logs API access is an add-on feature

To enable this feature, contact us at help@foxpass.com

Suggest Edits

Whitelisted IPs

 
Suggest Edits

/whitelist_ips/

Get list of all whitelist IP entries

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/whitelist_ips/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/whitelist_ips/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": [{"name": "test", "enabled": true, "ip_address": "127.0.0.1"}, {"name": "prod", "enabled": true, "ip_address": "127.0.0.2", "end_ip_address": "127.0.0.3"}]}
 
Suggest Edits

/whitelist_ips/

Create a new whitelist IP entry

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/whitelist_ips/
curl -H 'Authorization: Token API_KEY' -X POST -d '{"name": "prod", "ip_address": "127.0.0.2", "end_ip_address": "127.0.0.3"}' https://api.foxpass.com/v1/whitelist_ips/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Body Params

name
string
required

Entry name

ip_address
string
required

IP address or range or CIDR range

end_ip_address
string

End IP address (if specifying an IP range)

 
Suggest Edits

/whitelist_ips/:whitelist_ip/

Get info for a whitelist IP entry

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/whitelist_ips/:whitelistip/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/whitelist_ips/test/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": [{"name": "test", "enabled": true, "ip_address": "127.0.0.1"}]}

Path Params

whitelist_ip
string
required

name of the whitelist IP entry

 
Suggest Edits

/whitelist_ips/:whitelist_ip/

Enable or disable a whitelist IP entry

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.foxpass.com/v1/whitelist_ips/:whitelistip/
curl -H 'Authorization: Token API_KEY'  -X PUT -d '{"enabled": false}' https://api.foxpass.com/v1/whitelist_ips/test/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Path Params

whitelist_ip
string
required

name of the whitelist IP entry

Query Params

enabled
boolean

the status of the entry

 
Suggest Edits

/whitelist_ips/:whitelist_ip/

Delete a whitelist IP entry

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.foxpass.com/v1/whitelist_ips/:whitelistip/
curl -H 'Authorization: Token API_KEY'  -X DELETE https://api.foxpass.com/v1/whitelist_ips/test/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Path Params

whitelist_ip
string
required

name of the whitelist IP entry

 
Suggest Edits

MAC Addresses

 
Suggest Edits

/mac_entries/

Get list of all MAC entries

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/mac_entries/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/mac_entries/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": [{"name": "Apple TVs"}, {"name": "VOIP phones"}, {"name": "Security Cameras"}]}
 
Suggest Edits

/mac_entries/

Create a new MAC entry

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.foxpass.com/v1/mac_entries/
curl -H 'Authorization: Token API_KEY' -X POST -d '{"name": "Alexas"}' https://api.foxpass.com/v1/mac_entries/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}

Body Params

name
string
required

Entry name

 
Suggest Edits

/mac_entries/:entry_name/

Check to see whether a given MAC entry exists

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/mac_entries/:entry_name/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/mac_entries/Apple%20TVs/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": {"name": "Apple TVs"}}
 
Suggest Edits

/mac_entries/:entry_name/

Delete a single MAC entry

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.foxpass.com/v1/mac_entries/:entry_name/
curl -H 'Authorization: Token API_KEY' -X DELETE https://api.foxpass.com/v1/mac_entries/Apple%20TVs/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}
 
Suggest Edits

/mac_entries/:entry_name/prefixes/

Get a single MAC entry

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/mac_entries/:entry_name/prefixes/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/mac_entries/Apple%20TVs/prefixes/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": ["aa:bb:cc", "11:22"]}
 
Suggest Edits

/mac_entries/:entry_name/prefixes/

Add a prefix to a MAC entry

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.foxpass.com/v1/mac_entries/:entry_name/prefixes/
curl -H 'Authorization: Token API_KEY' -X PUT -d '{"prefix": "bb:cc:dd"}' https://api.foxpass.com/v1/mac_entries/Apple%20TVs/prefixes/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}
 
Suggest Edits

/mac_entries/:entry_name/prefixes/:prefix/

Check to see if a prefix exists in a given MAC entry

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.foxpass.com/v1/mac_entries/:entry_name/prefixes/:prefix/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/mac_entries/Apple%20TVs/prefixes/aa:bb/
A binary file was returned

You couldn't be authenticated

{"status": "ok", "data": true}
 
Suggest Edits

/mac_entries/:entry_name/prefixes/:prefix/

Deletes a prefix for a given MAC entry

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.foxpass.com/v1/mac_entries/:entry_name/prefixes/:prefix/
curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/mac_entries/Apple%20TVs/prefixes/
A binary file was returned

You couldn't be authenticated

{"status": "ok"}
 
});