Overview
API Concepts Manage API Key
Internet Data
DNSIQ® WHOISIQ™ SSL Certificates Blacklist Lookup Host Attributes
Attack Analytics
Newly Observed Domains Newly Observed Hosts Malware Phishing Scam Content
Digital Footprint
Global Inventory API Global Inventory Schema
Coming Soon
Enrich
PassiveTotal
Actions Artifact Enrichment Exposed Services Monitor Project SSL Certificates Tag Artifact Trackers Host Attributes Passive DNS Whois Bulk Enrichment
Additional Resources
Workspace Management API
RiskIQ.com

Project

The Project endpoints allow you to see all the information related to a project.

 

What It Looks Like

Add Project Tags

Add project tags.

Curl Example

$ curl -u $USERNAME:$KEY 'https://api.riskiq.net/pt/v2/project/tag' -XPOST -H "Content-Type: application/json" --data '{"project": "09c82680-0679-f55d-61db-2ec02376afc6", "tags": ["baz"]}'
        

Parameters

Field Field Type Description
project UUID the project id to update
tags String[] the tags or tag to add (list or str)

JSON Request

{
    "project": "09c82680-0679-f55d-61db-2ec02376afc6",
    "tags": [
        "baz"
    ]
}
            

Sample Response

{
    "visibility": "private",
    "owner": "riskiq",
    "active": true,
    "description": "",
    "subscribers": [
        "sim.gretina@example.org"
    ],
    "creator": "sim.gretina@example.org",
    "guid": "09c82680-0679-f55d-61db-2ec02376afc6",
    "featured": false,
    "tags": [
        "bar",
        "baz",
        "foo"
    ],
    "collaborators": [],
    "name": "test proj",
    "created": "2017-04-15T00:10:45.093000",
    "organization": "riskiq",
    "links": {
        "tag": "/pt/v2/project/tag?project=09c82680-0679-f55d-61db-2ec02376afc6",
        "self": "/pt/v2/project?project=09c82680-0679-f55d-61db-2ec02376afc6",
        "artifact": "/pt/v2/artifact?project=09c82680-0679-f55d-61db-2ec02376afc6"
    },
    "success": true
}
			

Create Project

Create a new project

Curl Example

$ curl -u $USERNAME:$KEY 'https://api.riskiq.net/pt/v2/project' -XPUT -H "Content-Type: application/json" --data '{"name": "My Public Project", "visibility": "public", "description": "my project!", "tags": ["newproject", "myownproject"]}'
            

Parameters

Field Field Type Description
name String name of the project
visibility String the visibility
Allowed values: public, private, analyst
description (optional)String the description
featured (optional)Boolean whether to feature the project
tags (optional)String[] sets the project's tags to this list

JSON Request

{
    "name": "My Public Project",
    "visibility": "public",
    "description": "my project!",
    "tags": [
        "newproject",
        "myownproject"
    ]
}
            

Sample Response

{
    "visibility": "public",
    "owner": "riskiq",
    "active": true,
    "description": "my project!",
    "subscribers": [
        "sim.gretina@example.org"
    ],
    "creator": "sim.gretina@example.org",
    "guid": "82927c81-20c4-38dd-fcfc-bba3605e28e4",
    "featured": false,
    "tags": [
        "newproject",
        "myownproject"
    ],
    "collaborators": [],
    "name": "My Public Project",
    "created": "2017-04-14T23:49:05.711977",
    "organization": "riskiq",
    "links": {
        "tag": "/pt/v2/project/tag?project=82927c81-20c4-38dd-fcfc-bba3605e28e4",
        "self": "/pt/v2/project?project=82927c81-20c4-38dd-fcfc-bba3605e28e4",
        "artifact": "/pt/v2/artifact?project=82927c81-20c4-38dd-fcfc-bba3605e28e4"
    },
    "success": true
}
			

Delete Project

Delete project

Curl Example

$ curl -u $USERNAME:$KEY 'https://api.riskiq.net/pt/v2/project/tag' -XPOST -H "Content-Type: applicati$ curl -u $USERNAME:$KEY 'https://api.riskiq.net/pt/v2/project' -XDELETE -H "Content-Type: application/json" --data '{"project": "82927c81-20c4-38dd-fcfc-bba3605e28e4"}'
            

Parameters

Field Field Type Description
project UUID the project id to delete

JSON Request

{
    "project": "82927c81-20c4-38dd-fcfc-bba3605e28e4"
}
            

Sample Response

{
    "visibility": "public",
    "owner": "riskiq",
    "active": true,
    "description": "my project!",
    "subscribers": [
        "sim.gretina@example.org"
    ],
    "creator": "sim.gretina@example.org",
    "guid": "82927c81-20c4-38dd-fcfc-bba3605e28e4",
    "featured": false,
    "tags": [],
    "collaborators": [],
    "name": "My Public Project",
    "created": "2017-04-14T23:49:05.711977",
    "organization": "riskiq",
    "links": {
        "tag": "/pt/v2/project/tag?project=82927c81-20c4-38dd-fcfc-bba3605e28e4",
        "self": "/pt/v2/project?project=82927c81-20c4-38dd-fcfc-bba3605e28e4",
        "artifact": "/pt/v2/artifact?project=82927c81-20c4-38dd-fcfc-bba3605e28e4"
    },
    "success": true
}
			

Find Project

Retrieves a project or projects by search filter

Curl Example

# As URL parameters
$ curl -u $USERNAME:$KEY 'https://api.riskiq.net/pt/v2/project?owner=riskiq&featured=true&visibility=public'
            

Parameters

Field Field Type Description
project (optional)UUID filter by project id
owner (optional)String filter by owner (an email or organization id)
creator (optional)String filter by creator email
organization (optional)String filter by organization
visibility (optional)String filter by visibility
Allowed values: public, private, analyst
featured (optional)Boolean filter by featured status

Sample Response

{
    "results": [
        {
            "name": "RIG Exploit Kit",
            "collaborators": [],
            "links": {
                "artifact": "/pt/v2/artifact?project=182d1a3a-5be3-dad4-76b8-67f8f79e8488",
                "self": "/pt/v2/project?project=182d1a3a-5be3-dad4-76b8-67f8f79e8488",
                "tag": "/pt/v2/project/tag?project=182d1a3a-5be3-dad4-76b8-67f8f79e8488"
            },
            "active": true,
            "creator": "sim.gretina@example.org",
            "created": "2016-11-16T05:55:00.425000",
            "subscribers": [
                "sim.gretina@example.org"
            ],
            "guid": "182d1a3a-5be3-dad4-76b8-67f8f79e8488",
            "tags": [
                "crimeware",
                "exploit kit",
                "rig"
            ],
            "visibility": "public",
            "organization": "riskiq",
            "owner": "riskiq",
            "featured": true,
            "description": "Browser exploit kit used for distribution of malware to vulnerable computers"
        }
    ],
    "success": true
}
			

Remove Project Tags

Remove project tags.

Curl Example

$ curl -u $USERNAME:$KEY 'https://api.riskiq.net/pt/v2/project/tag' -XDELETE -H "Content-Type: application/json" --data '{"project": "09c82680-0679-f55d-61db-2ec02376afc6", "tags": ["baz"]}'
            

Parameters

Field Field Type Description
project UUID the project id to update
tags String[] the tags or tag to remove (list or str)

JSON Request

{
    "project": "09c82680-0679-f55d-61db-2ec02376afc6",
    "tags": [
        "baz"
    ]
}
            

Sample Response

{
    "visibility": "private",
    "owner": "riskiq",
    "active": true,
    "description": "",
    "subscribers": [
        "sim.gretina@example.org"
    ],
    "creator": "sim.gretina@example.org",
    "guid": "09c82680-0679-f55d-61db-2ec02376afc6",
    "featured": false,
    "tags": [
        "quux"
    ],
    "collaborators": [],
    "name": "test proj",
    "created": "2017-04-15T00:10:45.093000",
    "organization": "riskiq",
    "links": {
        "tag": "/pt/v2/project/tag?project=09c82680-0679-f55d-61db-2ec02376afc6",
        "self": "/pt/v2/project?project=09c82680-0679-f55d-61db-2ec02376afc6",
        "artifact": "/pt/v2/artifact?project=09c82680-0679-f55d-61db-2ec02376afc6"
    },
    "success": true
}
			

Set Project Tags

Set project tags.

Curl Example

$ curl -u $USERNAME:$KEY 'https://api.riskiq.net/pt/v2/project/tag' -XPUT -H "Content-Type: application/json" --data '{"project": "09c82680-0679-f55d-61db-2ec02376afc6", "tags": ["baz", "quux"]}'
            

Parameters

Field Field Type Description
project UUID the project id to update
tags String[] the tags or tag to set to (list or str)

JSON Request

{
    "project": "09c82680-0679-f55d-61db-2ec02376afc6",
    "tags": [
        "baz",
        "quux"
    ]
}
            

Sample Response

{
    "visibility": "private",
    "owner": "riskiq",
    "active": true,
    "description": "",
    "subscribers": [
        "sim.gretina@example.org"
    ],
    "creator": "sim.gretina@example.org",
    "guid": "09c82680-0679-f55d-61db-2ec02376afc6",
    "featured": false,
    "tags": [
        "baz",
        "quux"
    ],
    "collaborators": [],
    "name": "test proj",
    "created": "2017-04-15T00:10:45.093000",
    "organization": "riskiq",
    "links": {
        "tag": "/pt/v2/project/tag?project=09c82680-0679-f55d-61db-2ec02376afc6",
        "self": "/pt/v2/project?project=09c82680-0679-f55d-61db-2ec02376afc6",
        "artifact": "/pt/v2/artifact?project=09c82680-0679-f55d-61db-2ec02376afc6"
    },
    "success": true
}
			

Update Project

Updates a project denoted by project ID

Curl Example

$ curl -u $USERNAME:$KEY 'https://api.riskiq.net/pt/v2/project' -XPOST -H "Content-Type: application/json" --data '{"project": "0ad0b885-a2f1-4021-adf0-3ca8f924fb33", "name": "My Public Project", "featured": true, "visibility": "public"}'
            

Parameters

Field Field Type Description
projectUUID the project id to update
name (optional)String the new name
description (optional)String the new description
visibility (optional)String the visibility
Allowed values: public, private, analyst
Default value: public
featured (optional)Boolean whether to feature the project
tags (optional)String[] sets the project's tags to this list

JSON Request

{
    "project": "0ad0b885-a2f1-4021-adf0-3ca8f924fb33",
    "name": "My Public Project!!!",
    "featured": true,
    "visibility": "public"
}
            

Sample Response

{
    "visibility": "public",
    "owner": "riskiq",
    "active": true,
    "description": "my project!",
    "subscribers": [
        "sim.gretina@example.org"
    ],
    "creator": "sim.gretina@example.org",
    "guid": "82927c81-20c4-38dd-fcfc-bba3605e28e4",
    "featured": true,
    "tags": [],
    "collaborators": [],
    "name": "My Public Project!!!",
    "created": "2017-04-14T23:49:05.711977",
    "organization": "riskiq",
    "links": {
        "tag": "/pt/v2/project/tag?project=82927c81-20c4-38dd-fcfc-bba3605e28e4",
        "self": "/pt/v2/project?project=82927c81-20c4-38dd-fcfc-bba3605e28e4",
        "artifact": "/pt/v2/artifact?project=82927c81-20c4-38dd-fcfc-bba3605e28e4"
    },
    "success": true
}