ThreatAgent JSON API

ThreatAgent API

The ThreatAgent API includes the following calls:

API clients:

• The ThreatAgent Gem
• The ThreatAgent iOS app

API calls:

Every call expects a key parameter to me passed in. API calls work by passing parameters in like this:

# Get information on your ThreatAgentaccount
curl https://threatagent.com/api/v1/info?key=32alphanumapikeyyekipamunahpla23
# Launch a Drone mission against Acme(acme.co)
curl https://threatagent.com/api/v1/drone/launch?key=32alphanumapikeyyekipamunahpla23&company=Acme&domain=acme.co

Utility API calls:

• GET /api/v1/info

Drone API calls:

• GET /api/v1/drone/launch - requires 'company' and 'domain' as parameters.
• GET /api/v1/drone/status - can accept 'company' and/or 'domain' as parameters.
• GET /api/v1/drone/results - requires 'company' and/or 'domain' as parameters.

In the case of an error you'll receive a response like the following:

{
    "error": "A descriptive error message."
}

---

GET /api/v1/info:

{
  "plan": "Free",
  "drone_queries": [
    {
      "company": "Acme",
      "id": 1,
      "domain": "acme.co",
      "created_at": "2013-04-12T03:34:47Z",
      "updated_at": "2013-04-12T03:34:47Z"
    }
  ]
}

GET /api/v1/drone/launch:

{
    "status": "Queued"
}

GET /api/v1/status:

[
    {
        "company": "Acme",
        "domain": "acme.com",
        "status": "Done",
        "created_at": "2013-04-12T03:33:04Z",
        "updated_at": "2013-04-12T03:34:47Z"
    }
]

GET /api/v1/drone/results:

[
    {
        "company": "Acme",
        "domain": "acme.co",
        "results": {
            "domains": {
                "acme.co": {
                    "www": "1.2.3.4"
                }
            },
            "domain": "acme.co",
            "hostnames": {
                "www": "1.2.3.4"
            },
            "company": "Acme",
            "geo_hosts": [
                {
                    "request": "www.acme.co",
                    "ip": "1.2.3.4",
                    "country_code2": "US",
                    "country_code3": "USA",
                    "country_name": "United States",
                    "continent_code": "NA",
                    "region_name": "CA",
                    "city_name": "Mountain View",
                    "postal_code": "94043",
                    "latitude": 37.41919999999999,
                    "longitude": -122.0574,
                    "dma_code": 807,
                    "area_code": 650,
                    "timezone": "America/Los_Angeles"
                }
            ],
            "address_whois": {
                "parts": [
                    {
                        "body": "",
                        "host": "1.2.3.4"
                    }
                ],
                "server": {
                    "type": "ipv4",
                    "allocation": "0.0.0.0/1",
                    "host": "",
                    "options": {},
                    "buffer": []
                },
                "content": ""
            },
            "domain_whois": "",
            "search_results": {
                "http://acme.co": "Acme Corp"
            },
            "emails": [],
            "pgp_emails": {
                "Wile E. Coyote": "wilecoyote@acme.co"
            },
            "shodan": {
                "total": 1,
                "matches": [
                    {
                        "ip": "1.2.3.4",
                        "port": 22,
                        "updated": "24.01.2013",
                        "data": "OpenSSH 1.99"
                    }
                ]
            },
            "detect": {
                "byod": false,
                "cloudflare": false,
                "exchange": false,
                "google_apps": false,
                "owa": false,
                "sharepoint": false
            },
            "shodan_names": {
                "1.2.3.4": "acme.co"
            },
            "humans": [],
            "generated_emails": [
                [
                    {
                        "firstlast": {
                          "name": "Bugs Bunny",
                          "username":"bugsbunny",
                          "domain":"@acme.co",
                          "headline":"Comedian at Warner Brothers Studios"
                        }
                    }
                ]
            ],
            "attack_surface": 1,
            "success_rating": 1
        },
        "created_at": "2013-04-12T04:08:20Z",
        "updated_at": "2013-04-12T04:08:20Z"
    }
]