MasterList V1 API
MasterList V1 API
Health Check
The health-check will show return status 200 with text body:
URL: /master-list/health-check
Method: GET
Example Response:
This is Master List V2 API!
Service Description
The service-description will show following information for an API:
Gives the Python Version the API using
Gives the list of all installed Python packages
Gives the name of API
Gives all the available versions
Gives a list of middleware being used
Gives all available routes for each versions.
URL: /master-list/service-description
Method: GET
Example Response:
{
"user_id": "1",
"request_from": "dev testing the GET data",
"request_id": "master_list-request-id-4a7f8742-a5cb-4f2f-82f9-1c1e45792c36",
"trace_id": "master_list-trace-id-35e9d517-2efb-4185-a8af-2d836a34f0f9",
"data": {
"python_version": "3.9.5",
"installed_packages": [
"falcon==3.1.0",
...
],
"name": "master_list",
"versions": [
"v1",
"v2"
],
"middleware": [
"FalconHealthCheckMiddleware",
"FalconLoggerSetupMiddleware",
"FalconResponseGeneratorMiddleware"
],
"routes": {
"v1": {
"brief-category": [
"delete",
"get",
"get_filter",
"post",
"put"
],
...
}
}
}
}
Risk Category Resource
- class v1.resources.gcri_category.GCRICategoryResource
GCRI Category Resource Class
# note:: Allowed Methods: GET
GET Method
- GCRICategoryResource.on_get(req: Request, resp: Response, pk=None)
GCRI Category GET Method
To get single object:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/risk-category/<:id>
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-b828be87-4bbe-4179-a7f1-068c03bf9adc", "trace_id": "master_list-trace-id-115096ea-6ea3-4c58-97a9-e7898ee35c95", "data": [ { "id": "004000000000001", "name": "Cyber + Information", "slug": "cyber-information", "description": null, "parent": null } ] }
To get multiple objects:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/risk-category
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-11d10a87-8949-4550-8e35-99d0d615c8c4", "trace_id": "master_list-trace-id-5095091a-ac9a-4a0d-ac9b-1164b27a8f67", "data": [ { "id": "004000000000001", "name": "Cyber + Information", "slug": "cyber-information", "description": null, "parent": null }, { "id": "004000000000002", "name": "Geopolitical", "slug": "geopolitical", "description": null, "parent": null } ] }
Region Resource
- class v1.resources.region.RegionResource
Region Resource Class
# note:: Allowed Methods: GET
GET Method
- RegionResource.on_get(req: Request, resp: Response, pk=None)
Region GET Method
To get single object:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/region/<:id>
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-107101e2-d012-4945-8567-b368b4c379c0", "trace_id": "master_list-trace-id-c84e56bc-76b8-4ae8-8103-6fc485384583", "data": [ { "name": "East Asia & the Pacific", "slug": "east-asia-and-the-pacific", "id": "005000000000001", "countries": [ "004000000000011", "004000000000019", "004000000000037", "004000000000042", "004000000000050", "004000000000056", "004000000000211", "004000000000077", "004000000000080", "004000000000090", "004000000000237", "004000000000102", "004000000000103", "004000000000110", "004000000000115", "004000000000116", "004000000000117", "004000000000120", "004000000000240", "004000000000132", "004000000000136", "004000000000140", "004000000000143", "004000000000158", "004000000000004", "004000000000151", "004000000000152", "004000000000162", "004000000000164", "004000000000167", "004000000000182", "004000000000190", "004000000000194", "004000000000207", "004000000000210", "004000000000213", "004000000000219", "004000000000227", "004000000000229", "004000000000231" ] } ] }
To get multiple objects:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/region
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-ded1180a-7e3c-449b-ad51-072cedb5eb1f", "trace_id": "master_list-trace-id-c1a5146c-d3cf-46b0-87bc-e4f8903dfa0b", "data": [ { "name": "East Asia & the Pacific", "slug": "east-asia-and-the-pacific", "id": "005000000000001", "countries": [ "004000000000011", "004000000000019", "004000000000037", "004000000000042", "004000000000050", "004000000000056", "004000000000211", "004000000000077", "004000000000080", "004000000000090", "004000000000237", "004000000000102", "004000000000103", "004000000000110", "004000000000115", "004000000000116", "004000000000117", "004000000000120", "004000000000240", "004000000000132", "004000000000136", "004000000000140", "004000000000143", "004000000000158", "004000000000004", "004000000000151", "004000000000152", "004000000000162", "004000000000164", "004000000000167", "004000000000182", "004000000000190", "004000000000194", "004000000000207", "004000000000210", "004000000000213", "004000000000219", "004000000000227", "004000000000229", "004000000000231" ] }, { "name": "Europe & Eurasia", "slug": "europe-and-eurasia", "id": "005000000000002", "countries": [ "004000000000009", "004000000000012", "004000000000017", "004000000000020", "004000000000021", "004000000000026", "004000000000027", "004000000000033", "004000000000038", "004000000000059", "004000000000063", "004000000000064", "004000000000073", "004000000000076", "004000000000078", "004000000000079", "004000000000083", "004000000000084", "004000000000086", "004000000000087", "004000000000092", "004000000000099", "004000000000100", "004000000000105", "004000000000106", "004000000000108", "004000000000111", "004000000000121", "004000000000126", "004000000000127", "004000000000128", "004000000000129", "004000000000135", "004000000000141", "004000000000142", "004000000000150", "004000000000159", "004000000000169", "004000000000170", "004000000000173", "004000000000174", "004000000000183", "004000000000187", "004000000000192", "004000000000193", "004000000000198", "004000000000204", "004000000000205", "004000000000221", "004000000000223" ] }, { "name": "Near East & North Africa", "slug": "near-east-and-north-africa", "id": "005000000000003", "countries": [ "004000000000010", "004000000000023", "004000000000062", "004000000000069", "004000000000104", "004000000000107", "004000000000112", "004000000000118", "004000000000122", "004000000000125", "004000000000146", "004000000000160", "004000000000172", "004000000000185", "004000000000206", "004000000000215", "004000000000216", "004000000000222", "004000000000007", "004000000000232" ] } ] }
Key Term Resource
- class v1.resources.key_term.KeyTermResource
Key Term Resource Class
# note:: Allowed Methods: GET
GET Method
- KeyTermResource.on_get(req: Request, resp: Response, pk=None)
Key Term GET Method
To get single object:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/key-term/<:id>
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-107101e2-d012-4945-8567-b368b4c379c0", "trace_id": "master_list-trace-id-c84e56bc-76b8-4ae8-8103-6fc485384583", "data": [ { "id": "003000000000001", "name": "Accounting", "slug": "accounting", "description": null } ] }
To get multiple objects:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/key-term
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-ded1180a-7e3c-449b-ad51-072cedb5eb1f", "trace_id": "master_list-trace-id-c1a5146c-d3cf-46b0-87bc-e4f8903dfa0b", "data": [ { "id": "003000000000001", "name": "Accounting", "slug": "accounting", "description": null }, { "id": "003000000000002", "name": "Alcohol", "slug": "alcohol", "description": null }, { "id": "003000000000003", "name": "Anti-Boycott", "slug": "anti-boycott", "description": null } ] }
Country Resource
- class v1.resources.country.CountryResource
Country Resource Class
# note:: Allowed Methods: GET
GET Method
- CountryResource.on_get(req: Request, resp: Response, pk=None)
Country GET Method
To get single object:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/country/<:id>
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-05c3101d-8702-4941-ae7d-9e4b46cff10e", "trace_id": "master_list-trace-id-fb45443e-6b42-4386-8fb4-04d691ffb130", "data": [ { "name": "South Georgia and the South Sandwich Islands", "slug": "south-georgia-and-south-sandwich-islands", "alpha_2": "GS", "alpha_3": "SGS", "capital": "King Edward Point", "id": "004000000000001", "regions": [], "aliases": [] } ] }
To get multiple objects:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/country
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-564d94f3-90ff-41a9-b8a8-ec4591777b86", "trace_id": "master_list-trace-id-c331828c-1ad4-4dfd-99d0-7c90de757ec9", "data": [ { "name": "South Georgia and the South Sandwich Islands", "slug": "south-georgia-and-south-sandwich-islands", "alpha_2": "GS", "alpha_3": "SGS", "capital": "King Edward Point", "id": "004000000000001", "regions": [], "aliases": [] }, { "name": "French Southern and Antarctic Lands", "slug": "french-southern-and-antarctic-lands", "alpha_2": "TF", "alpha_3": "ATF", "capital": "Saint-Pierre on Reunion Island", "id": "004000000000002", "regions": [], "aliases": [] }, { "name": "Palestine", "slug": "palestine", "alpha_2": "PS", "alpha_3": "PSE", "capital": "Jerusalem", "id": "004000000000003", "regions": [], "aliases": [] } ] }
Language Resource
- class v1.resources.language.LanguageResource
Language Resource Class
# note:: Allowed Methods: GET
GET Method
- LanguageResource.on_get(req: Request, resp: Response, pk=None)
Language GET Method
To get single object:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/language/<:id>
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-107101e2-d012-4945-8567-b368b4c379c0", "trace_id": "master_list-trace-id-c84e56bc-76b8-4ae8-8103-6fc485384583", "data": [ { "name": "Armenian", "slug": "armenian", "alpha_2": "hy", "alpha_3": "arm", "rtl": 0, "id": "006000000000001" } ] }
To get multiple objects:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/language
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-ded1180a-7e3c-449b-ad51-072cedb5eb1f", "trace_id": "master_list-trace-id-c1a5146c-d3cf-46b0-87bc-e4f8903dfa0b", "data": [ { "name": "Armenian", "slug": "armenian", "alpha_2": "hy", "alpha_3": "arm", "rtl": 0, "id": "006000000000001" }, { "name": "Spanish", "slug": "spanish", "alpha_2": "es", "alpha_3": "spa", "rtl": 0, "id": "006000000000002" }, { "name": "English", "slug": "english", "alpha_2": "en", "alpha_3": "eng", "rtl": 0, "id": "006000000000003" } ] }
Product And Service Resource
- class v1.resources.product_and_service.ProductAndServiceResource
Product and Service Resource Class
# note:: Allowed Methods: GET
GET Method
- ProductAndServiceResource.on_get(req: Request, resp: Response, pk=None)
Product and Service GET Method
To get single object:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/product-and-service/<:id>
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-107101e2-d012-4945-8567-b368b4c379c0", "trace_id": "master_list-trace-id-c84e56bc-76b8-4ae8-8103-6fc485384583", "data": [ { "id": "002000000000001", "name": "Academic / Public Sector / Practitioner Advisory", "slug": "academic-public-sector-practitioner-advisory", "description": null, "parent": null } ] }
To get multiple objects:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/product-and-service
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-ded1180a-7e3c-449b-ad51-072cedb5eb1f", "trace_id": "master_list-trace-id-c1a5146c-d3cf-46b0-87bc-e4f8903dfa0b", "data": [ { "id": "002000000000001", "name": "Academic / Public Sector / Practitioner Advisory", "slug": "academic-public-sector-practitioner-advisory", "description": null, "parent": null }, { "id": "002000000000002", "name": "Consulting", "slug": "consulting", "description": null, "parent": null }, { "id": "002000000000003", "name": "Managed Services", "slug": "managed-services", "description": null, "parent": null } ] }
Industry Resource
- class v1.resources.industry.IndustryResource
Industry Resource Class
# note:: Allowed Methods: GET
GET Method
- IndustryResource.on_get(req: Request, resp: Response, pk=None)
Industry GET Method
To get single object:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/industry/<:id>
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-107101e2-d012-4945-8567-b368b4c379c0", "trace_id": "master_list-trace-id-c84e56bc-76b8-4ae8-8103-6fc485384583", "data": [ { "id": "007000000000001", "name": "Industry One", "slug": "industry-one", "naics_code": 1 } ] }
To get multiple objects:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/industry
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-ded1180a-7e3c-449b-ad51-072cedb5eb1f", "trace_id": "master_list-trace-id-c1a5146c-d3cf-46b0-87bc-e4f8903dfa0b", "data": [ { "id": "007000000000001", "name": "Industry One", "slug": "industry-one", "naics_code": 1 }, { "id": "007000000000002", "name": "Industry Two", "slug": "industry-two", "naics_code": 2 } ] }
Worldview Themes Resource
- class v1.resources.worldview_theme.WorldViewThemeResource
WorldView Resource Class
# note:: Allowed Methods: GET
GET Method
- WorldViewThemeResource.on_get(req: Request, resp: Response, pk=None)
Worldview Theme GET Method
To get single object:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/worldview-themes/<:id>
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-107101e2-d012-4945-8567-b368b4c379c0", "trace_id": "master_list-trace-id-c84e56bc-76b8-4ae8-8103-6fc485384583", "data": [ { "id": "009000000000001", "slug": "economics", "display_name": "Economics", "description": null, "taxonomy_id": 1663, "vocabulary_id": 33, "is_active": 1, "is_deleted": 0 } ] }
To get multiple objects:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/worldview-themes
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-ded1180a-7e3c-449b-ad51-072cedb5eb1f", "trace_id": "master_list-trace-id-c1a5146c-d3cf-46b0-87bc-e4f8903dfa0b", "data": [ { "id": "009000000000001", "slug": "economics", "display_name": "Economics", "description": null, "taxonomy_id": 1663, "vocabulary_id": 33, "is_active": 1, "is_deleted": 0 }, { "id": "009000000000002", "slug": "energy", "display_name": "Energy", "description": null, "taxonomy_id": 1664, "vocabulary_id": 33, "is_active": 1, "is_deleted": 0 }, { "id": "009000000000003", "slug": "military-security", "display_name": "Military & Security", "description": null, "taxonomy_id": 1665, "vocabulary_id": 33, "is_active": 1, "is_deleted": 0 }, { "id": "009000000000004", "slug": "politics", "display_name": "Politics", "description": null, "taxonomy_id": 1666, "vocabulary_id": 33, "is_active": 1, "is_deleted": 0 } ] }
Worldview Topics Resource
- class v1.resources.worldview_topic.WorldViewTopicResource
WorldView Topic Resource Class
# note:: Allowed Methods: GET
GET Method
- WorldViewTopicResource.on_get(req: Request, resp: Response, pk=None)
Worldview Topic GET Method
To get single object:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/worldview-topics/<:id>
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-107101e2-d012-4945-8567-b368b4c379c0", "trace_id": "master_list-trace-id-c84e56bc-76b8-4ae8-8103-6fc485384583", "data": [ { "id": "010000000000001", "slug": "covid-19", "display_name": "COVID-19", "description": null, "taxonomy_id": 1668, "vocabulary_id": 34, "is_active": 1, "is_deleted": 0 } ] }
To get multiple objects:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/worldview-topics
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-ded1180a-7e3c-449b-ad51-072cedb5eb1f", "trace_id": "master_list-trace-id-c1a5146c-d3cf-46b0-87bc-e4f8903dfa0b", "data": [ { "id": "010000000000001", "slug": "covid-19", "display_name": "COVID-19", "description": null, "taxonomy_id": 1668, "vocabulary_id": 34, "is_active": 1, "is_deleted": 0 }, { "id": "010000000000002", "slug": "us-china-relations", "display_name": "U.S.-China Relations", "description": null, "taxonomy_id": 1669, "vocabulary_id": 34, "is_active": 1, "is_deleted": 0 }, { "id": "010000000000003", "slug": "us-iran-relations", "display_name": "U.S.-Iran Relations", "description": null, "taxonomy_id": 1670, "vocabulary_id": 34, "is_active": 1, "is_deleted": 0 } ] }
Taxonomy Threat Lens Resource
- class v1.resources.taxonomy_threat_lens.TaxonomyThreatLensResource
Taxonomy Threat Lens Resource Class
# note:: Allowed Methods: GET
GET Method
- TaxonomyThreatLensResource.on_get(req: Request, resp: Response, pk=None)
Taxonomy Threat lens GET Method
To get single object:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/taxonomy-threat-lens/<:id>
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-107101e2-d012-4945-8567-b368b4c379c0", "trace_id": "master_list-trace-id-c84e56bc-76b8-4ae8-8103-6fc485384583", "data": [ { "id": "011000000000001", "name": "Criminal Activity", "slug": "criminal-activity", "description": null, "is_active": 1, "is_deleted": 0, "parent": null } ] }
To get multiple objects:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/taxonomy-threat-lens
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-ded1180a-7e3c-449b-ad51-072cedb5eb1f", "trace_id": "master_list-trace-id-c1a5146c-d3cf-46b0-87bc-e4f8903dfa0b", "data": [ { "id": "011000000000001", "name": "Criminal Activity", "slug": "criminal-activity", "description": null, "is_active": 1, "is_deleted": 0, "parent": null }, { "id": "011000000000002", "name": "Cyber & Information Threats", "slug": "cyber-information-threats", "description": null, "is_active": 1, "is_deleted": 0, "parent": null }, { "id": "011000000000003", "name": "Environmental, Health & Infrastructure Hazards", "slug": "environmental-health-infrastructure-hazards", "description": null, "is_active": 1, "is_deleted": 0, "parent": null } ] }
Intel Fusion Taxonomy ThreatLens Mapping Resource
- class v1.resources.intel_fusion_taxonomy_threat_lens_mapping.IntelFusionTaxonomyThreatLensMappingResource
Intel Fusion Taxonomy Threat lens Mapping Resource Class
# note:: Allowed Methods: GET
GET Method
- IntelFusionTaxonomyThreatLensMappingResource.on_get(req: Request, resp: Response)
Intel Fusion Taxonomy Threat Lens Resource GET Method
To get multiple objects:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/intel-fusion-tl-mapping
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-ded1180a-7e3c-449b-ad51-072cedb5eb1f", "trace_id": "master_list-trace-id-c1a5146c-d3cf-46b0-87bc-e4f8903dfa0b", "data": [ { "id": 1, "intel_fusion_label": "Attack Helicopter", "threat_lens_incident_type": 41 }, { "id": 2, "intel_fusion_label": "Attack Helicopter", "threat_lens_incident_type": 39 }, { "id": 3, "intel_fusion_label": "Bomber", "threat_lens_incident_type": 42 } ] }
Threat Lens Old New Mapping Resource
- class v1.resources.threat_lens_old_new_mapping.ThreatLensOldNewMappingResource
Threat lens old new mapping Resource Class
# note:: Allowed Methods: GET
GET Method
- ThreatLensOldNewMappingResource.on_get(req: Request, resp: Response)
Threat Lens Old New Mapping Resource GET Method
To get multiple objects:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/threat-lens-old-new-tags-mapping
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-ded1180a-7e3c-449b-ad51-072cedb5eb1f", "trace_id": "master_list-trace-id-c1a5146c-d3cf-46b0-87bc-e4f8903dfa0b", "data": [ { "id": "011000000000001", "old_threat_lens_tag": "Armed Assault", "new_threat_lens_tag": 15 }, { "id": "011000000000002", "old_threat_lens_tag": "Arson", "new_threat_lens_tag": 7 }, { "id": "011000000000003", "old_threat_lens_tag": "Assassination or Attempted Assassination", "new_threat_lens_tag": 11 } ] }
Intel Fusion Impact Rating Resource
- class v1.resources.intel_fusion_impact_rating.IntelFusionImpactRatingResource
Intel Fusion Impact Rating Resource Class
# note:: Allowed Methods: GET
GET Method
- IntelFusionImpactRatingResource.on_get(req: Request, resp: Response, pk=None)
Intel Fusion Impact Rating GET Method
To get single object:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/intel-fusion-threat-impact-rating/<:id>
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-107101e2-d012-4945-8567-b368b4c379c0", "trace_id": "master_list-trace-id-c84e56bc-76b8-4ae8-8103-6fc485384583", "data": [ { "id": "012000000000001", "name": "Unknown", "external_id": -1, "description": "Impact has not been assessed or is unknown.", "is_deleted": 0 } ] }
To get multiple objects:
Request
Method:
GETURL: https://stag.api.ranenetwork.com/master-list/v1/intel-fusion-threat-impact-rating
Response Object:
{ "user_id": "1", "request_from": "user", "request_id": "master_list-request-id-ded1180a-7e3c-449b-ad51-072cedb5eb1f", "trace_id": "master_list-trace-id-c1a5146c-d3cf-46b0-87bc-e4f8903dfa0b", "data": [ { "id": "012000000000001", "name": "Unknown", "external_id": -1, "description": "Impact has not been assessed or is unknown.", "is_deleted": 0 }, { "id": "012000000000002", "name": "Insignificant", "external_id": 1, "description": "No injuries or health effects. Financial loss less than $1,000 USD. No lost time workdays. No impact on reputation. Fully reversible impacts.", "is_deleted": 0 }, { "id": "012000000000003", "name": "Limited", "external_id": 2, "description": "Minimal injuries or health effects. Financial loss more than $1,000 USD but less than $5,000 USD. Limited business interruption, less than 1 lost time workday. Limited negative reputational exposure. Mostly reversible impacts.", "is_deleted": 0 } ] }