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
Additional Resources
PassiveTotal API Workspace Management API
RiskIQ.com

Workspace Management

A collection of APIs meant to programmatically manage workspace wide settings.

 

What It Looks Like

Get Brands

Get all active brands for a workspace.

Get Brands Example

curl -X GET --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/brand/'

Create Brands

Bulk creates brands for a given workspace

Create Bands Example

curl -X POST --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/brand/' -H "Content-Type: application/json" -d '{
    "brands": [
        {
            "name": "MyBrand1"    
        },
        {
            "name": "MyBrand2"
        }
    ]
}'
            

Update Brands

Bulk updates brands for a given workspace. The changedName attribute is required, but either a name or id can be provided to specify which brand to update.

Update Brands Example

curl -X PUT --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/brand/' -H "Content-Type: application/json" -d '{
   "brands": [
        {
            "name": "MyBrand1",
            "changedName": "MyUpdatedBrand1"    
        },
        {
            "name": "MyBrand2",
            "changedName": "MyUpdatedBrand2"        
        }
   ]
}'
        
or
curl -X PUT --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/brand/' -H "Content-Type: application/json" -d '{
    "brands": [
        {
            "id": 3762,
            "changedName": "MyUpdatedBrand1"    
        },
        {
            "id": 3763,
            "changedName": "MyUpdatedBrand2"        
        }
    ]
}'
            

Delete Brands

Bulk deletes brands from a given workspace.

Delete Brands Example

curl -X DELETE --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/brand/' -H "Content-Type: application/json" -d '{
    "brands": [
        {
            "name": "MyBrand1"
        },
        {
            "name": "MyBrand2"        
        }
    ]
}'
            
or
curl -X DELETE --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/brand/' -H "Content-Type: application/json" -d '{
    "brands": [
        {
            "id": 3762
        },
        {
            "id": 3763
        }
    ]
}'
            

Get Organizations

Get all active organizations for a workspace.

Get Organizations Example

curl -X GET --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/organization/'

Create Organizations

Bulk creates organizations for a given workspace

Create Organizations Example

curl -X POST --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/organization/' -H "Content-Type: application/json" -d '{
    "organizations": [
        {
            "name": "MyOrganization1"    
        },
        {
            "name": "MyOrganization2"
        }
    ]
}'
            

Update Organizations

Bulk updates organizations for a given workspace. The changedName attribute is required, but either a name or id can be provided to specify which organization to update.

Bulk Update Organizations Example

curl -X PUT --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/organization/' -H "Content-Type: application/json" -d '{
   "organizations": [
        {
            "name": "MyOrganization1",
            "changedName": "MyUpdatedOrganization1"    
        },
        {
            "name": "MyOrganization2",
            "changedName": "MyUpdatedOrganization2"        
        }
   ]
}'
        
or
curl -X PUT --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/organization/' -H "Content-Type: application/json" -d '{
    "organizations": [
        {
            "id": 3762,
            "changedName": "MyUpdatedOrganization1"    
        },
        {
            "id": 3763,
            "changedName": "MyUpdatedOrganization2"        
        }
    ]
}'
            

Delete Organizations

Bulk deletes organizations from a given workspace.

Delete Organizations Example

curl -X DELETE --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/organization/' -H "Content-Type: application/json" -d '{
    "organizations": [
        {
            "name": "MyOrganization1"
        },
        {
            "name": "MyOrganization2"        
        }
    ]
}'
            
or
curl -X DELETE --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/organization/' -H "Content-Type: application/json" -d '{
    "organizations": [
        {
            "id": 3762
        },
        {
            "id": 3763
        }
    ]
}'
            

Get Tags

Get all active tags for a workspace.

Get Tags Example

curl -X GET --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/tag/'

Create Tags

Bulk creates tags for a given workspace. Name and color are both required. Valid color options are:

Color
yellow
orange
green
green-2
red
purple
gray
dark gray
blue
black
white
indigo

Create Tags Example

curl -X POST --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/tag/' -H "Content-Type: application/json" -d '{
    "tags": [
        {
            "name": "MyTag1",
            "type": "INVENTORY",
            "color": "blue"    
        },
        {
            "name": "MyTag2",
            "type": "EVENT",
            "color": "yellow"
        }
    ]
}'
            

Update Tags

Bulk updates tags for a given workspace. The changedName attribute is required, but either a name or id can be provided to specify which tag to update. The tag type is required for an update by name. The color can also be updated.

Bulk Update Tags Example

curl -X PUT --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/tag/' -H "Content-Type: application/json" -d '{
   "tags": [
        {
            "name": "MyTag1",
            "type": "INVENTORY",
            "changedName": "MyUpdatedTag1"    
        },
        {
            "name": "MyTag2",
            "type": "EVENT",
            "changedName": "MyUpdatedTag2",
            "color": "indigo"        
        }
   ]
}'
        
or
curl -X PUT --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/tag/' -H "Content-Type: application/json" -d '{
    "tags": [
        {
            "id": 3762,
            "changedName": "MyUpdatedTag1"    
        },
        {
            "id": 3763,
            "changedName": "MyUpdatedTag2",
            "color": "indigo"         
        }
    ]
}'
            

Delete Tags

Bulk deletes tags from a given workspace. The delete can be performed based upon the tag name or the tag id. The tag type is required for delete by name.

Delete Tags Example

curl -X DELETE --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/tag/' -H "Content-Type: application/json" -d '{
    "tags": [
        {
            "name": "MyTag1",
            "type": "INVENTORY"
        },
        {
            "name": "MyTag2"
            "type": "EVENT"
        }
    ]
}'
            
or
curl -X DELETE --header 'Accept: application/json' --header "Authorization: Basic $ENCODED_API_KEY" 'https://api.riskiq.net/v0/workspace/tag/' -H "Content-Type: application/json" -d '{
    "tags": [
        {
            "id": 3762
        },
        {
            "id": 3763
        }
    ]
}'