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
Getting Started Actions Artifact Articles Data Card Enrichment Services Monitor Project SSL Certificates Tag Artifact Trackers Host Attributes Cookies Components 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"]}'
        

JSON Request

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

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"]}'
            

JSON Request

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

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"}'
            

JSON Request

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

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'
            

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"]}'
            

JSON Request

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

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"]}'
            

JSON Request

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

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"}'
            

JSON Request

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

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
}