CTX for GPT
CTX for GPT 路 Acciones GPT
CTX (Cyber Threat X)
The CTX (Cyber Threat X) API provides an external integration interface designed to offer comprehensive cyber threat intelligence and analysis. It enables users to retrieve detailed information and assessments on various cyber threats, including file hashes, IP addresses, domains, threat actors, and specific cyber campaigns. This API aims to enhance cybersecurity measures by offering real-time data and insights into potential cyber threats, facilitating a proactive approach to threat detection and mitigation
GET /fileget_file_reportAPI for Retrieving File Hash Analysis Results Using Hash Values
GET /ipget_ip_reportAPI for Retrieving IP Address Analysis Results Using IP Address Values
GET /domainget_domain_reportAPI for Retrieving Domain Analysis Results Using Domain Values
GET /threat-actorget_threat_actor_reportAPI for Retrieving threat-actor Analysis Results Using threat-actor name
GET /attack-countryget_attack_country_reportAPI for Retrieving attack-country Analysis Results Using attack-country name
GET /victim-countryget_victim_country_reportAPI for Retrieving victim-country Analysis Results Using victim-country name
Esquema original API
{
"openapi": "3.1.0",
"info": {
"title": "CTX (Cyber Threat X)",
"description": "The CTX (Cyber Threat X) API provides an external integration interface designed to offer comprehensive cyber threat intelligence and analysis. It enables users to retrieve detailed information and assessments on various cyber threats, including file hashes, IP addresses, domains, threat actors, and specific cyber campaigns. This API aims to enhance cybersecurity measures by offering real-time data and insights into potential cyber threats, facilitating a proactive approach to threat detection and mitigation",
"version": "v1.1.0"
},
"servers": [
{
"url": "https://gpt.ctx.io/api/v2"
}
],
"paths": {
"/file": {
"get": {
"description": "API for Retrieving File Hash Analysis Results Using Hash Values",
"operationId": "get_file_report",
"parameters": [
{
"name": "hash",
"in": "query",
"description": "File Hash values (MD5, SHA1, SHA256)",
"required": true,
"schema": {
"type": "string"
}
}
],
"deprecated": false,
"responses": {
"200": {
"description": "CTX File Hash Analysis Results Search",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
"default": {
"description": "Search Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/ip": {
"get": {
"description": "API for Retrieving IP Address Analysis Results Using IP Address Values",
"operationId": "get_ip_report",
"parameters": [
{
"name": "ip_addr",
"in": "query",
"description": "IP Address values",
"required": true,
"schema": {
"type": "string"
}
}
],
"deprecated": false,
"responses": {
"200": {
"description": "CTX IP Address Analysis Results Search",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPResponse"
}
}
}
},
"default": {
"description": "Search Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/domain": {
"get": {
"description": "API for Retrieving Domain Analysis Results Using Domain Values",
"operationId": "get_domain_report",
"parameters": [
{
"name": "domain",
"in": "query",
"description": "Domain values",
"required": true,
"schema": {
"type": "string"
}
}
],
"deprecated": false,
"responses": {
"200": {
"description": "CTX Domain Analysis Results Search",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainResponse"
}
}
}
},
"default": {
"description": "Search Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/threat-actor": {
"get": {
"description": "API for Retrieving threat-actor Analysis Results Using threat-actor name",
"operationId": "get_threat_actor_report",
"parameters": [
{
"name": "name",
"in": "query",
"description": "threat-actor name",
"required": true,
"schema": {
"type": "string"
}
}
],
"deprecated": false,
"responses": {
"200": {
"description": "CTX threat-actor Results Search",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThreatActorResponse"
}
}
}
},
"default": {
"description": "Search Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/attack-country": {
"get": {
"description": "API for Retrieving attack-country Analysis Results Using attack-country name",
"operationId": "get_attack_country_report",
"parameters": [
{
"name": "country",
"in": "query",
"description": "attack-country (code or name)",
"required": true,
"schema": {
"type": "string"
}
}
],
"deprecated": false,
"responses": {
"200": {
"description": "CTX attack-country Results Search",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttackCountryResponse"
}
}
}
},
"default": {
"description": "Search Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/victim-country": {
"get": {
"description": "API for Retrieving victim-country Analysis Results Using victim-country name",
"operationId": "get_victim_country_report",
"parameters": [
{
"name": "country",
"in": "query",
"description": "victim-country (code or name)",
"required": true,
"schema": {
"type": "string"
}
}
],
"deprecated": false,
"responses": {
"200": {
"description": "CTX victim ountry Results Search",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VictimCountryResponse"
}
}
}
},
"default": {
"description": "Search Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"FileResponse": {
"type": "object",
"properties": {
"result_code": {
"type": "integer",
"description": "Response Code"
},
"result_msg": {
"type": "string",
"description": "Response Message"
},
"ctx_data_description": {
"type": "string",
"description": "Description of API"
},
"request_data": {
"type": "string",
"description": "Requested File Hash Value"
},
"file_ctx_data": {
"description": "Search Result",
"$ref": "#/components/schemas/CtxData"
}
}
},
"IPResponse": {
"type": "object",
"properties": {
"result_code": {
"type": "integer",
"description": "Response Code"
},
"result_msg": {
"type": "string",
"description": "Response Message"
},
"ctx_data_description": {
"type": "string",
"description": "Description of API"
},
"request_data": {
"type": "string",
"description": "Requested IP Address Value"
},
"ip_ctx_data": {
"description": "Search Result",
"$ref": "#/components/schemas/CtxData"
}
}
},
"DomainResponse": {
"type": "object",
"properties": {
"result_code": {
"type": "integer",
"description": "Response Code"
},
"result_msg": {
"type": "string",
"description": "Response Message"
},
"ctx_data_description": {
"type": "string",
"description": "Description of API"
},
"request_data": {
"type": "string",
"description": "Requested Domain Value"
},
"domain_ctx_data": {
"description": "Search Result",
"$ref": "#/components/schemas/CtxData"
}
}
},
"ThreatActorResponse": {
"type": "object",
"properties": {
"result_code": {
"type": "integer",
"description": "Response Code"
},
"result_msg": {
"type": "string",
"description": "Response Message"
},
"request_data": {
"type": "string",
"description": "Requested Actor Name Value"
},
"actor_ctx_data": {
"description": "Search Result",
"$ref": "#/components/schemas/threat_actor_CtxData"
}
}
},
"AttackCountryResponse": {
"type": "object",
"properties": {
"result_code": {
"type": "integer",
"description": "Response Code"
},
"result_msg": {
"type": "string",
"description": "Response Message"
},
"request_data": {
"type": "string",
"description": "Requested Country Value"
},
"acc_ctx_data": {
"description": "Search Result",
"$ref": "#/components/schemas/attack_country_CtxData"
}
}
},
"VictimCountryResponse": {
"type": "object",
"properties": {
"result_code": {
"type": "integer",
"description": "Response Code"
},
"result_msg": {
"type": "string",
"description": "Response Message"
},
"request_data": {
"type": "string",
"description": "Requested Country Value"
},
"vcc_ctx_data": {
"description": "Search Result",
"$ref": "#/components/schemas/victim_country_CtxData"
}
}
},
"CtxData": {
"type": "object",
"properties": {
"is_malware": {
"type": "boolean",
"description": "Malware or Not"
},
"detection": {
"type": "string",
"description": "Detection Name"
},
"file_type": {
"type": "string",
"description": "File Type"
},
"file_size": {
"type": "string",
"description": "File Size"
},
"total_related_file_iocs": {
"type": "array",
"description": "List of All Associated File Hashes",
"items": {
"type": "string"
}
},
"total_related_ip_iocs": {
"type": "array",
"description": "List of All Associated IP Addresses",
"items": {
"type": "string"
}
},
"total_related_domain_iocs": {
"type": "array",
"description": "List of All Associated Domains",
"items": {
"type": "string"
}
},
"campaigns": {
"description": "detailed information on file-related campaigns, including a count of total campaigns and a list of dictionaries for each campaign with specific details",
"$ref": "#/components/schemas/Campaigns"
},
"mitre_attack_techniques": {
"type": "array",
"description": "MITRE ATT&CK T-ID List",
"items": {
"type": "string"
}
}
}
},
"Campaigns": {
"type": "object",
"properties": {
"count": {
"description": "a count of total campaigns",
"type": "integer"
},
"list": {
"type": "array",
"description": "list of dictionaries for each campaign with specific details",
"items": {
"$ref": "#/components/schemas/Campaign"
}
}
}
},
"Campaign": {
"type": "object",
"properties": {
"threat_actors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThreatActor"
},
"description": "List of Threat Actor Groups Associated with the Campaign"
},
"target_industries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TargetIndustry"
},
"description": "List of Target Industries Associated with the Campaign"
},
"target_countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TargetCountry"
},
"description": "List of Target Countries Associated with the Campaign"
},
"related_file_iocs": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of File Hashes Associated with the Campaign"
},
"related_ip_iocs": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of IPs Associated with the Campaign"
},
"related_domain_iocs": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of Domains Associated with the Campaign"
}
}
},
"ThreatActor": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Threat Actor Name"
},
"country_code": {
"type": "string",
"description": "Country Code of the Threat Actor"
}
}
},
"TargetIndustry": {
"type": "object",
"properties": {
"industry": {
"type": "string",
"description": "Industry Name (Industry Major Category: Industry Subcategory)"
},
"percentage": {
"type": "number",
"format": "float",
"description": "Industry Ratio"
}
}
},
"TargetCountry": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country Code"
},
"percentage": {
"type": "number",
"format": "float",
"description": "Country Ratio"
}
}
},
"threat_actor_CtxData": {
"type": "object",
"description": "Search Result of request_data",
"properties": {
"total_related_file_iocs": {
"type": "array",
"description": "List of All Associated File Hashes",
"items": {
"type": "string"
}
},
"total_related_ip_iocs": {
"type": "array",
"description": "List of All Associated IP Addresses",
"items": {
"type": "string"
}
},
"total_related_domain_iocs": {
"type": "array",
"description": "List of All Associated Domains",
"items": {
"type": "string"
}
},
"campaigns": {
"description": "detailed information on request_data-related campaigns, including a count of total campaigns and a list of dictionaries for each campaign with specific details",
"$ref": "#/components/schemas/Campaigns"
}
}
},
"attack_country_CtxData": {
"type": "object",
"description": "Search Result of request_data",
"properties": {
"total_related_file_iocs": {
"type": "array",
"description": "List of All Associated File Hashes",
"items": {
"type": "string"
}
},
"total_related_ip_iocs": {
"type": "array",
"description": "List of All Associated IP Addresses",
"items": {
"type": "string"
}
},
"total_related_domain_iocs": {
"type": "array",
"description": "List of All Associated Domains",
"items": {
"type": "string"
}
},
"campaigns": {
"description": "detailed information on request_data-related campaigns, including a count of total campaigns and a list of dictionaries for each campaign with specific details",
"$ref": "#/components/schemas/Campaigns"
}
}
},
"victim_country_CtxData": {
"type": "object",
"description": "Search Result of request_data",
"properties": {
"total_related_file_iocs": {
"type": "array",
"description": "List of All Associated File Hashes",
"items": {
"type": "string"
}
},
"total_related_ip_iocs": {
"type": "array",
"description": "List of All Associated IP Addresses",
"items": {
"type": "string"
}
},
"total_related_domain_iocs": {
"type": "array",
"description": "List of All Associated Domains",
"items": {
"type": "string"
}
},
"campaigns": {
"description": "detailed information on request_data-related campaigns, including a count of total campaigns and a list of dictionaries for each campaign with specific details",
"$ref": "#/components/schemas/Campaigns"
}
}
},
"UnexpectedError": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "string",
"description": "Timestamp of Error Occurrence"
},
"status": {
"type": "integer",
"description": "HTTP Status Code"
},
"error": {
"type": "string",
"description": "Error Type or Message"
},
"path": {
"type": "string",
"description": "Path of the Requested Resource"
}
},
"required": [
"timestamp",
"status",
"error",
"path"
]
},
"ExpectedError": {
"type": "object",
"properties": {
"result_code": {
"type": "integer",
"description": "Result Code"
},
"result_msg": {
"type": "string",
"description": "Result Message"
}
},
"required": [
"result_code",
"result_msg"
]
},
"ErrorResponse": {
"type": "object",
"properties": {
"error": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ExpectedError"
},
{
"$ref": "#/components/schemas/UnexpectedError"
}
]
}
}
}
}
}
}