From 6b95102ca0411e5ed4ead25a928bc04e280e3176 Mon Sep 17 00:00:00 2001 From: Oleh Shumov Date: Wed, 4 Dec 2024 13:42:34 +0100 Subject: [PATCH] Update oas.json --- oas.json | 2412 +++++++++++++++++++----------------------------------- 1 file changed, 837 insertions(+), 1575 deletions(-) diff --git a/oas.json b/oas.json index 3cbfa15..442cf01 100644 --- a/oas.json +++ b/oas.json @@ -1,1724 +1,986 @@ { - "openapi": "3.0.0", - "x-stoplight": { - "id": "0s1fx0ffj6b7g" - }, - "info": { - "title": "test2", - "version": "1.0", - "description": "Contiant payments and data API", - "contact": { - "name": "Contiant Ltd", - "url": "https://contiant.com", - "email": "contact@contiant.com" - }, - "license": { - "name": "MIT", - "url": "https://opensource.org/licenses/MIT" - } - }, - "servers": [ - { - "url": "https://httpbin.org/anything", - "description": "Production environment" + "components": { + "securitySchemes": { + "sec0": { + "in": "query", + "name": "x-apikey", + "type": "apiKey" } - ], - "paths": { - "/token": { - "post": { - "summary": "Generate Token", - "operationId": "generate-token", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_token": { - "type": "string" - }, - "expires_in": { - "type": "integer" - }, - "token_type": { - "type": "string" - } - }, - "required": [ - "access_token", - "expires_in", - "token_type" - ] - }, - "examples": { - "Example": { - "value": { - "access_token": "eyJraWQiOiI1RFJSVDZEcGw5YnVaM3NISDQxQ2Y0b1BPM0RWUkE5VWh4NFFWUks0ZlwvWT0iLCJhbGciOiJSUzI1NiJ9", - "expires_in": 3600, - "token_type": "Bearer" - } - } + } + }, + "info": { + "title": "Vulnerability Intelligence", + "version": "3.0" + }, + "openapi": "3.1.0", + "tags": [ + { + "name": "Vulnerabilities" + } + ], + "paths": { + "/collections": { + "get": { + "tags": [ + "Vulnerabilities" + ], + "deprecated": false, + "description": "", + "operationId": "list-vulnerabilities", + "parameters": [ + { + "description": "Your API key", + "in": "header", + "name": "x-apikey", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Maximum number of vulnerabilities to retrieve (max 40)", + "in": "query", + "name": "limit", + "schema": { + "default": 10, + "format": "int32", + "type": "integer" + } + }, + { + "description": "Continuation cursor", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + }, + { + "description": "Filter vulnerabilities / objects by different properties", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Sorting order", + "in": "query", + "name": "order", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n\"meta\": {\n \"cursor\": \n},\n\"data\": [\n ,\n ,\n ...\n],\n\"links\": {\n \"self\": ,\n \"next\": \n}" } } } - } + }, + "description": "200" }, - "description": "Generates new token using client_id and client_secret (available for verified merchants in the Merchant Dashboard)", - "requestBody": { + "400": { "content": { - "application/x-www-form-urlencoded": { + "application/json": { + "examples": { + "Result": { + "value": "{}" + } + }, "schema": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "client_secret": { - "type": "string" - } - }, - "required": [ - "client_id", - "client_secret" - ] + "properties": {}, + "type": "object" } } - } - }, - "tags": [ - "Authentication" - ] - } - }, - "/banks/{countryCode}": { + }, + "description": "400" + } + }, + "summary": "List vulnerabilities" + } + }, + "/collections/{id}": { + "get": { + "tags": [ + "Vulnerabilities" + ], + "deprecated": false, + "description": "", + "operationId": "get-vulnerability", "parameters": [ { + "description": "Your API key", + "in": "header", + "name": "x-apikey", + "required": true, "schema": { "type": "string" - }, - "name": "countryCode", - "description": "Country code in ISO 3166-1 alpha-2 format", + } + }, + { + "description": "Vulnerability's ID", "in": "path", - "required": true + "name": "id", + "required": true, + "schema": { + "type": "string" + } } ], - "get": { - "summary": "Get Banks", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "bankName": { - "type": "string", - "description": "Name of the bank" - }, - "bankId": { - "type": "string", - "description": "Id of the bank that will be used for payments" - } - }, - "required": [ - "bankName", - "bankId" - ] - } - }, - "examples": { - "Example": { - "value": [ - { - "bankName": "Deutsche Postbank Sandbox", - "bankId": "postbank-sandbox" - }, - { - "bankName": "Revolut EU Sandbox", - "bankId": "revolut_eu-sandbox" - } - ] - } + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{}" } + }, + "schema": { + "properties": {}, + "type": "object" } } - } + }, + "description": "200" }, - "operationId": "get-banks", - "description": "Get available banks for specific country", - "tags": [ - "Single Immediate Payments (PIS)" - ], - "security": [ - { - "Token": [] - } - ] - } - }, - "/payments": { - "post": { - "summary": "Create Payment", - "operationId": "create-payment", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "status": { - "type": "string" - }, - "paymentUrl": { - "type": "string" - } - }, - "required": [ - "id", - "status", - "paymentUrl" - ] - }, - "examples": { - "Example": { - "value": { - "id": "ff04170a-2590-49a8-9583-a3f758227107", - "status": "success", - "paymentUrl": "https://paywith.contiant.com/?paymentId=d94bfa45-b1e9-45dc-9dd8-06b55bee2f03" - } - } + "400": { + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{}" } + }, + "schema": { + "properties": {}, + "type": "object" } } }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string" - }, - "errorMessages": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "error", - "errorMessages" - ] - }, - "examples": { - "Invalid value": { - "value": { - "error": "InvalidInput", - "errorMessages": [ - "amountInMinorUnit is required" - ] - } - } + "description": "400" + } + }, + "security": [], + "summary": "Get a vulnerability" + } + }, + "/collections/{id}/relationships/{relationship}": { + "get": { + "tags": [ + "Vulnerabilities" + ], + "deprecated": false, + "description": "", + "operationId": "get-vulnerability-related-descriptors", + "parameters": [ + { + "description": "Your API key", + "in": "header", + "name": "x-apikey", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Vulnerability's ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Relationship name (see [table](ref:vulnerability-object#relationships))", + "in": "path", + "name": "relationship", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Maximum number of related objects to retrieve", + "in": "query", + "name": "limit", + "schema": { + "default": 10, + "format": "int32", + "type": "integer" + } + }, + { + "description": "Continuation cursor", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{}" } + }, + "schema": { + "properties": {}, + "type": "object" } } }, - "401": { - "description": "Unauthorized" - } + "description": "200" }, - "description": "Create new payment session.\n\n **For payments in `GBP`**\n\nMerchant's accountIdentifications must provide `SORT_CODE` and `ACCOUNT_NUMBER` instead of `IBAN` and `BIC`. Check the \"Payment in GBP\" from the Examples dropdown\n\n **For payments in `NZD`**\n\nMerchant's accountIdentifications can be an empty array. Check the \"Payment in NZD\" from the Examples dropdown", - "security": [ - { - "Token": [] - } - ], - "requestBody": { + "400": { "content": { "application/json": { - "schema": { - "type": "object", - "properties": { - "amountInMinorUnit": { - "type": "number", - "description": "Monetary value in minor unit amount" - }, - "currency": { - "type": "string", - "description": "Currency code in ISO 4217 format" - }, - "country": { - "type": "string", - "description": "Country code in ISO 3166-1 alpha-2 format. The consumer will only see banks available in the specified country" - }, - "consumerId": { - "type": "string", - "description": "Uniquely identifies the consumer, we recommend that a v4 UUID is supplied" - }, - "consumerFirstName": { - "type": "string", - "description": "First name of the consumer" - }, - "consumerLastName": { - "type": "string", - "description": "Last name of the consumer" - }, - "consumerEmail": { - "type": "string", - "description": "Email of the consumer" - }, - "merchantName": { - "type": "string", - "description": "Name of the merchant" - }, - "accountsDetails": { - "type": "object", - "required": [ - "merchant" - ], - "properties": { - "merchant": { - "type": "object", - "description": "Merchant bank account details", - "required": [ - "accountIdentifications", - "address", - "name" - ], - "properties": { - "accountIdentifications": { - "type": "array", - "maxItems": 0, - "nullable": true, - "description": "The account details that identify the Merchant bank account. If IBAN is provided, BIC will be required.If ACCOUNT_NUMBER is provided, SORT_NUMBER will be required", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "IBAN", - "BIC", - "SORT_CODE", - "ACCOUNT_NUMBER" - ], - "description": "Used to describe the format of the account" - }, - "identification": { - "type": "string", - "description": "The value associated with the account identification type" - } - } - }, - "default": [] - }, - "address": { - "type": "object", - "required": [ - "country", - "postCode" - ], - "properties": { - "country": { - "type": "string", - "description": "Country code in ISO 3166-1 alpha-2 format. The country code of the merchant's IBAN" - }, - "postCode": { - "type": "string", - "description": "The post code of the merchant's address" - } - } - }, - "name": { - "type": "string", - "description": "Name of the bank account holder" - } - } - } - } - }, - "bankId": { - "type": "string", - "description": "Bank id code, if provided the bank will be preselected on the payment form" - }, - "merchantReferenceId": { - "type": "string", - "description": "Merchant reference of the payment" - }, - "returnUrl": { - "type": "string", - "description": "URL where the consumer will be redirected after payment completion" - }, - "failUrl": { - "type": "string", - "description": "URL where the consumer will be redirected in case of payment failure" - }, - "vip": { - "type": "string", - "description": "Indicates if the consumer is VIP. Possible values: `YES`, `NO`" - } - }, - "required": [ - "amountInMinorUnit", - "consumerFirstName", - "consumerLastName", - "consumerEmail", - "currency", - "country", - "consumerId", - "merchantName", - "accountsDetails", - "merchantReferenceId", - "returnUrl" - ] - }, "examples": { - "Payment in NZD": { - "value": { - "amountInMinorUnit": 10, - "currency": "NZD", - "country": "NZ", - "consumerId": "ff04170a-2590-49a8-9583-a3f758227107", - "merchantName": "ACME Corporation", - "accountsDetails": { - "merchant": { - "name": "ACME Corporation", - "accountIdentifications": [], - "address": { - "country": "NZ", - "postCode": "1000" - } - } - }, - "merchantReferenceId": "b33d708b-1363-4384-b3d8-debdf6a63989", - "returnUrl": "https://merchant.com/returnUrl" - } - }, - "Payment not in GBP": { - "value": { - "amountInMinorUnit": 10, - "currency": "EUR", - "country": "BG", - "consumerId": "ff04170a-2590-49a8-9583-a3f758227107", - "merchantName": "ACME Corporation", - "accountsDetails": { - "merchant": { - "name": "ACME Corporation", - "accountIdentifications": [ - { - "type": "IBAN", - "identification": "BG32TTBB94009168491123" - }, - { - "type": "BIC", - "identification": "FINVBGSF" - } - ], - "address": { - "country": "BG", - "postCode": "1000" - } - } - }, - "merchantReferenceId": "b33d708b-1363-4384-b3d8-debdf6a63989", - "bankId": "revolut_eu", - "returnUrl": "https://merchant.com/returnUrl" - } - }, - "Payment in GBP": { - "value": { - "amountInMinorUnit": 10, - "currency": "EUR", - "country": "BG", - "consumerId": "ff04170a-2590-49a8-9583-a3f758227107", - "merchantName": "ACME Corporation", - "accountsDetails": { - "merchant": { - "name": "ACME Corporation", - "accountIdentifications": [ - { - "type": "SORT_CODE", - "identification": "123456" - }, - { - "type": "ACCOUNT_NUMBER", - "identification": "12345678" - } - ], - "address": { - "country": "GB", - "postCode": "SW1A 1AA" - } - } - }, - "merchantReferenceId": "b33d708b-1363-4384-b3d8-debdf6a63989", - "bankId": "revolut_eu", - "returnUrl": "https://merchant.com/returnUrl" - } + "Result": { + "value": "{}" } + }, + "schema": { + "properties": {}, + "type": "object" } } - } - }, - "tags": [ - "Single Immediate Payments (PIS)" - ] - } - }, - "/payments/{id}": { + }, + "description": "400" + } + }, + "security": [], + "summary": "Get object descriptors related to a vulnerability" + } + }, + "/collections/{id}/{relationship}": { + "get": { + "tags": [ + "Vulnerabilities" + ], + "deprecated": false, + "description": "", + "operationId": "get-vulnerability-relationships", "parameters": [ { + "description": "Your API key", + "in": "header", + "name": "x-apikey", + "required": true, "schema": { - "type": "string", - "format": "uuid" - }, + "type": "string" + } + }, + { + "description": "Vulnerability's ID", + "in": "path", "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Relationship name (see [table](ref:vulnerability-object#relationships))", "in": "path", + "name": "relationship", "required": true, - "description": "ID of the payment" + "schema": { + "type": "string" + } + }, + { + "description": "Maximum number of related objects to retrieve", + "in": "query", + "name": "limit", + "schema": { + "default": 10, + "format": "int32", + "type": "integer" + } + }, + { + "description": "Continuation cursor", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } } ], - "get": { - "summary": "Get Payment", - "description": "Get payment by ID", - "operationId": "get-payment", - "tags": [ - "Single Immediate Payments (PIS)" - ], - "security": [ - { - "Token": [] - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "Example": { - "value": "{\n \"id\": \"2081b923-c8da-4128-8b80-4af86341e734\",\n \"amountInMinorUnit\": \"1000\",\n \"currency\": \"EUR\",\n \"country\": \"DE\",\n \"status\": \"SETTLED\",\n \"consumerId\": \"123456789\",\n \"consumerFirstName\": \"John\",\n \"consumerLastName\": \"Doe\",\n \"consumerEmail\": \"johndoe@example.com\",\n \"merchantName\": \"ACME Ltd\",\n \"accountsDetails\": {\n \"merchant\": {\n \"name\": \"ACME Ltd\",\n \"accountIdentifications\": [\n {\n \"identification\": \"DE19510200003248345745\",\n \"type\": \"IBAN\"\n },\n {\n \"identification\": \"COBADEFFXXX\",\n \"type\": \"BIC\"\n }\n ],\n \"address\": {\n \"country\": \"DE\",\n \"postCode\": \"10115\"\n }\n },\n \"consumer\": {\n \"accountIdentifications\": [\n {\n \"identification\": \"DE46500202002153625337\",\n \"type\": \"IBAN\"\n }\n ]\n }\n },\n \"reference\": \"ABCD\",\n \"merchantReferenceId\": \"5e75484c-9da5-42c9-8ccd-99247ce268ad\",\n \"returnUrl\": \"https://returnurl.com\"\n}" - } - }, - "schema": { - "type": "object", - "required": [ - "id", - "amountInMinorUnit", - "currency", - "country", - "status", - "consumerId", - "merchantName", - "accountsDetails", - "reference", - "merchantReferenceId", - "returnUrl" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "example": "9a3fa926-67a2-45df-afcf-35832188ec21", - "description": "ID of the payment" - }, - "amountInMinorUnit": { - "type": "integer", - "example": 200, - "description": "Monetary value in minor unit amount" - }, - "currency": { - "type": "string", - "example": "EUR", - "description": "Currency code in ISO 4217 format" - }, - "country": { - "type": "string", - "example": "BG", - "description": "Country code in ISO 3166-1 alpha-2 format" - }, - "status": { - "type": "string", - "example": "COMPLETED", - "description": "Status of the payment" - }, - "consumerId": { - "type": "string", - "example": "1644b3a8-623e-4497-a20e-9184dcb8d37f", - "description": "Uniquely identifies the consumer, we recommend that a v4 UUID is supplied" - }, - "consumerFirstName": { - "type": "string", - "example": "John", - "description": "First name of the consumer" - }, - "consumerLastName": { - "type": "string", - "example": "Doe", - "description": "Last name of the consumer" - }, - "consumerEmail": { - "type": "string", - "example": "jd@example.com", - "description": "Email of the consumer" - }, - "merchantName": { - "type": "string", - "example": "Acme Corporation", - "description": "Name of the merchant" - }, - "accountsDetails": { - "type": "object", - "properties": { - "merchant": { - "type": "object", - "description": "Merchant bank account details", - "properties": { - "name": { - "type": "string", - "example": "Acme Corporation" - }, - "accountIdentifications": { - "type": "array", - "description": "The account details that identify the Merchant bank account. If IBAN is provided, BIC will be required.If ACCOUNT_NUMBER is provided, SORT_NUMBER will be required", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "IBAN", - "description": "Used to describe the format of the account" - }, - "identification": { - "type": "string", - "example": "BG58IORT80947118429754", - "description": "The value associated with the account identification type" - } - } - } - }, - "address": { - "type": "object", - "properties": { - "country": { - "type": "string", - "example": "BG", - "description": "Country code in ISO 3166-1 alpha-2 format" - }, - "postCode": { - "type": "string", - "example": "1000", - "description": "The post code of the address" - } - } - } - } - }, - "consumer": { - "type": "object", - "description": "Consumer bank account details, optional", - "properties": { - "accountIdentifications": { - "type": "array", - "description": "The account details that identify the Consumer bank account.", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "IBAN", - "description": "Used to describe the format of the account" - }, - "identification": { - "type": "string", - "example": "DE19510200003248345745", - "description": "The value associated with the account identification type" - } - } - } - } - } - } - } - }, - "reference": { - "type": "string", - "example": "13e7ba01-4f95-42f1-b48b-ccdd42651864", - "description": "Integrator reference of the payment" - }, - "merchantReferenceId": { - "type": "string", - "example": "4963e2d2-5c7f-4516-9cde-3aae328cc2ee", - "description": "Merchant reference of the payment" - }, - "returnUrl": { - "type": "string", - "example": "https://merchant.com/returnUrl", - "description": "URL where the consumer will be redirected after payment completion" - } - } + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{}" } + }, + "schema": { + "properties": {}, + "type": "object" } } - } + }, + "description": "200" + }, + "400": { + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{}" + } + }, + "schema": { + "properties": {}, + "type": "object" + } + } + }, + "description": "400" } - } - }, - "/data/banks/{countryCode}": { + }, + "security": [], + "summary": "Get objects related to a vulnerability" + } + }, + "/collections/{id}/comments": { + "get": { + "tags": [ + "Vulnerabilities" + ], + "deprecated": false, + "description": "", + "operationId": "get-vulnerability-comments", "parameters": [ { + "description": "Your API key", + "in": "header", + "name": "x-apikey", + "required": true, "schema": { "type": "string" - }, - "name": "countryCode", + } + }, + { + "description": "Vulnerability's ID", "in": "path", - "required": true + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Maximum number of comments to retrieve", + "in": "query", + "name": "limit", + "schema": { + "default": 10, + "format": "int32", + "type": "integer" + } + }, + { + "description": "Continuation cursor", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } } ], - "get": { - "summary": "Get Banks", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "bic": { - "type": "string" - }, - "transaction_total_days": { - "type": "integer" - }, - "countries": { - "type": "array", - "items": { - "type": "string" - } - }, - "logo": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "bic", - "transaction_total_days", - "countries", - "logo" - ] - } - }, - "examples": { - "Example": { - "value": [ - { - "id": "REVOLUT_REVOGB21", - "name": "Revolut", - "bic": "REVOGB21", - "transaction_total_days": 730, - "countries": [ - "BG", - "GB", - "NO", - "SE" - ], - "logo": "https://blog.revolut.com/content/images/2020/03/Revolut_Brand-Update.png" - } - ] - } + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{}" } + }, + "schema": { + "properties": {}, + "type": "object" } } + }, + "description": "200" + }, + "400": { + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{}" + } + }, + "schema": { + "properties": {}, + "type": "object" + } + } + }, + "description": "400" + } + }, + "security": [], + "summary": "Get comments on a vulnerability" + }, + "post": { + "tags": [ + "Vulnerabilities" + ], + "deprecated": false, + "description": "", + "operationId": "create-vulnerability-comment", + "parameters": [ + { + "description": "Your API key", + "in": "header", + "name": "x-apikey", + "required": true, + "schema": { + "type": "string" } }, - "operationId": "get-available-banks", - "description": "Get available banks", - "tags": [ - "Data (AIS)" - ], - "security": [ - { - "Token": [] + { + "description": "Vulnerability's ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" } - ], - "parameters": [ - { + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { - "type": "string", - "format": "uuid" - }, - "in": "query", - "name": "referenceId", - "description": "Unique ID for request", - "required": true + "properties": { + "data": { + "description": "A comment object", + "format": "json", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + } } - ] - } - }, - "/data/requisitions": { - "post": { - "summary": "Create Requisition", - "operationId": "create-requisition", - "requestBody": { + } + }, + "responses": { + "200": { "content": { "application/json": { - "schema": { - "type": "object", - "properties": { - "consumer_id": { - "type": "string" - }, - "redirect": { - "type": "string" - }, - "institution_id": { - "type": "string" - }, - "user_language": { - "type": "string" - } - }, - "required": [ - "consumer_id", - "redirect", - "institution_id", - "user_language" - ] - }, "examples": { - "Example": { - "value": { - "consumer_id": "ff04170a-2590-49a8-9583-a3f758227107", - "redirect": "https://example.com/callback", - "institution_id": "REVOLUT_REVOGB21", - "user_language": "en" - } + "Result": { + "value": "{}" } + }, + "schema": { + "properties": {}, + "type": "object" } } - } + }, + "description": "200" }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "Example": { - "value": { - "id": "aa6545c9-ff69-4e53-b24a-0308d4b3a1e0", - "created": "2022-06-23T21:42:29.514Z", - "redirect": "https://api.contiant.com/data/callback/success", - "status": "CR", - "institution_id": "REVOLUT_REVOGB21", - "reference": "6855585f-b396-4a24-998e-9f1f5229d8d5", - "user_language": "en", - "link": "https://contiant.com/psd2/start/aa6545c9-ff69-4e53-b24a-0308d4b3a1e0/REVOLUT_REVOGB21", - "account_selection": false, - "redirect_immediate": false - } - } + "400": { + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{}" } + }, + "schema": { + "properties": {}, + "type": "object" } } + }, + "description": "400" + } + }, + "security": [], + "summary": "Add a comment to a vulnerability" + } + }, + "/collections/{id}/search": { + "get": { + "tags": [ + "Vulnerabilities" + ], + "deprecated": false, + "description": "", + "operationId": "search-iocs-inside-a-vulnerability", + "parameters": [ + { + "description": "Your API key", + "in": "header", + "name": "x-apikey", + "required": true, + "schema": { + "type": "string" } }, - "tags": [ - "Data (AIS)" - ], - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "referenceId", - "required": true, - "description": "Unique ID for request" + { + "description": "Vulnerability's ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" } - ], - "security": [ - { - "Token": [] + }, + { + "description": "Intelligence query", + "in": "query", + "name": "query", + "required": true, + "schema": { + "type": "string" } - ] - } - }, - "/data/consumer/{consumerID}/{institutionID}": { - "parameters": [ + }, + { + "description": "Maximum number of IoCs to retrieve (max 40)", + "in": "query", + "name": "limit", + "schema": { + "default": 10, + "format": "int32", + "type": "integer" + } + }, + { + "description": "Continuation cursor", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + }, + { + "description": "Sorting order", + "in": "query", + "name": "order", + "schema": { + "type": "string" + } + }, { + "description": "Comma-separated attributes to return from the resulting IoCs", + "in": "query", + "name": "attributes", "schema": { "type": "string" + } + }, + { + "description": "Comma-separated name of relationships descriptors to return from the IoCs", + "in": "query", + "name": "relationships", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n\"meta\": {\n \"cursor\": ,\n \"total_hits\": ,\n \"allowed_orders\": [, ...]\n},\n\"data\": [\n ,\n ,\n ...\n],\n\"links\": {\n \"self\": ,\n \"next\": \n}" + } + } + }, + "text/plain": { + "examples": { + "Example": { + "value": "{\n\t\"data\":\n\t[\n\t\t{\n\t\t\t\"id\": \"1e6fcfadaacd23678c4708d3b006f9760feebdaff7f0903c012758a0c2dbecc8\",\n\t\t\t\"type\": \"file\",\n\t\t\t\"links\":\n\t\t\t{\n\t\t\t\t\"self\": \"https://www.virustotal.com/api/v3/files/1e6fcfadaacd23678c4708d3b006f9760feebdaff7f0903c012758a0c2dbecc8\"\n\t\t\t},\n\t\t\t\"attributes\":\n\t\t\t{\n\t\t\t\t\"names\":\n\t\t\t\t[\n\t\t\t\t\t\"D:\\Downloads\\msdt-follina-main.zip\",\n\t\t\t\t\t\"msdt-follina-main (1).zip\",\n\t\t\t\t\t\"msdt-follina-main.zip\"\n\t\t\t\t]\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"id\": \"f4156284935d45fdc0c5b1f1a2f5992e52250dfa5f903cc2068ba007bd280f92\",\n\t\t\t\"type\": \"file\",\n\t\t\t\"links\":\n\t\t\t{\n\t\t\t\t\"self\": \"https://www.virustotal.com/api/v3/files/f4156284935d45fdc0c5b1f1a2f5992e52250dfa5f903cc2068ba007bd280f92\"\n\t\t\t},\n\t\t\t\"attributes\":\n\t\t\t{\n\t\t\t\t\"names\":\n\t\t\t\t[]\n\t\t\t}\n\t\t}\n\t],\n\t\"meta\":\n\t{\n\t\t\"cursor\": \"eJwVjlFvgyAYRf8S0rmsj-sKbWzAQT9AecPqZgsaurkozX783OPJvffk_toqnNoQJzNGZyiNgOPugsKPGMOVZXE2vjWdCvcGh7P0hTqbsHGGpbIKXiCP9SZS5vNnCUXZeZSgiuO6nwzsuKYqgYkjI1sFQJ2kZDFDdnY-O65snbcT6JZ2Ot416HdN4jcEWXQqV2KYXKPU2o9fLVq9Q-TOkwSoPTmSEQHcNprmgORbo7b_v2qzf91-HBfMNssLg8uD3S6JQZ149c-2Z3uC-EFkFshSQuitsaGE_sYf8soHveatZwfrrRF5eaif2GqqsQ0Mi8SHorfwObN9PVuQw-rC9fwH-K1szw==\",\n\t\t\"total_hits\": 14,\n\t\t\"allowed_orders\":\n\t\t[\n\t\t\t\"first_submission_date\",\n\t\t\t\"last_submission_date\",\n\t\t\t\"positives\",\n\t\t\t\"times_submitted\",\n\t\t\t\"size\",\n\t\t\t\"unique_sources\",\n\t\t\t\"gti_score\"\n\t\t]\n\t},\n\t\"links\":\n\t{\n\t\t\"self\": \"https://www.virustotal.com/api/v3/collections/vulnerability--cve-2022-30190/search?query=tag:cve-2022-30190&attributes=names&limit=2\",\n\t\t\"next\": \"https://www.virustotal.com/api/v3/collections/vulnerability--cve-2022-30190/search?query=tag%3Acve-2022-30190&attributes=names&limit=2&cursor=eJwVjlFvgyAYRf8S0rmsj-sKbWzAQT9AecPqZgsaurkozX783OPJvffk_toqnNoQJzNGZyiNgOPugsKPGMOVZXE2vjWdCvcGh7P0hTqbsHGGpbIKXiCP9SZS5vNnCUXZeZSgiuO6nwzsuKYqgYkjI1sFQJ2kZDFDdnY-O65snbcT6JZ2Ot416HdN4jcEWXQqV2KYXKPU2o9fLVq9Q-TOkwSoPTmSEQHcNprmgORbo7b_v2qzf91-HBfMNssLg8uD3S6JQZ149c-2Z3uC-EFkFshSQuitsaGE_sYf8soHveatZwfrrRF5eaif2GqqsQ0Mi8SHorfwObN9PVuQw-rC9fwH-K1szw%3D%3D\"\n\t}\n}" + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "names": { + "items": { + "example": "280fbf353fdffefc5a0af40c706377142fff718c7b87bc8b0daab10849f388d0.rdp", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "example": "f4156284935d45fdc0c5b1f1a2f5992e52250dfa5f903cc2068ba007bd280f92", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "https://www.virustotal.com/api/v3/files/f4156284935d45fdc0c5b1f1a2f5992e52250dfa5f903cc2068ba007bd280f92", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "example": "file", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "next": { + "example": "https://www.virustotal.com/api/v3/collections/vulnerability--cve-2022-30190/search?query=tag%3Acve-2022-30190&attributes=names&limit=2&cursor=eJwVjlFvgyAYRf8S0rmsj-sKbWzAQT9AecPqZgsaurkozX783OPJvffk_toqnNoQJzNGZyiNgOPugsKPGMOVZXE2vjWdCvcGh7P0hTqbsHGGpbIKXiCP9SZS5vNnCUXZeZSgiuO6nwzsuKYqgYkjI1sFQJ2kZDFDdnY-O65snbcT6JZ2Ot416HdN4jcEWXQqV2KYXKPU2o9fLVq9Q-TOkwSoPTmSEQHcNprmgORbo7b_v2qzf91-HBfMNssLg8uD3S6JQZ149c-2Z3uC-EFkFshSQuitsaGE_sYf8soHveatZwfrrRF5eaif2GqqsQ0Mi8SHorfwObN9PVuQw-rC9fwH-K1szw%3D%3D", + "type": "string" + }, + "self": { + "example": "https://www.virustotal.com/api/v3/collections/vulnerability--cve-2022-30190/search?query=tag:cve-2022-30190&attributes=names&limit=2", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "allowed_orders": { + "items": { + "example": "first_submission_date", + "type": "string" + }, + "type": "array" + }, + "cursor": { + "example": "eJwVjlFvgyAYRf8S0rmsj-sKbWzAQT9AecPqZgsaurkozX783OPJvffk_toqnNoQJzNGZyiNgOPugsKPGMOVZXE2vjWdCvcGh7P0hTqbsHGGpbIKXiCP9SZS5vNnCUXZeZSgiuO6nwzsuKYqgYkjI1sFQJ2kZDFDdnY-O65snbcT6JZ2Ot416HdN4jcEWXQqV2KYXKPU2o9fLVq9Q-TOkwSoPTmSEQHcNprmgORbo7b_v2qzf91-HBfMNssLg8uD3S6JQZ149c-2Z3uC-EFkFshSQuitsaGE_sYf8soHveatZwfrrRF5eaif2GqqsQ0Mi8SHorfwObN9PVuQw-rC9fwH-K1szw==", + "type": "string" + }, + "total_hits": { + "default": 0, + "example": 138, + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + } }, - "name": "consumerID", + "description": "200" + } + }, + "summary": "Search IoCs inside a vulnerability" + } + }, + "/collections/{id}/download/{format}": { + "get": { + "tags": [ + "Vulnerabilities" + ], + "deprecated": false, + "description": "", + "operationId": "export-vulnerability-iocs", + "parameters": [ + { + "description": "Your API key", + "in": "header", + "name": "x-apikey", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Vulnerability's ID", "in": "path", + "name": "id", "required": true, - "description": "Id of the consumer, alphanumeric string up to 100 characters" + "schema": { + "type": "string" + } }, { - "schema": { - "type": "string" - }, - "name": "institutionID", + "description": "Export format (one of `json`, `csv`, or `stix`)", "in": "path", + "name": "format", "required": true, - "description": "Id of the institution" + "schema": { + "type": "string" + } } ], - "get": { - "summary": "Get Accounts", - "tags": [ - "Data (AIS)" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "created": { - "type": "string" - }, - "redirect": { - "type": "string" - }, - "status": { - "type": "string" - }, - "institution_id": { - "type": "string" - }, - "agreement": { + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"files\": [\n \"f4156284935d45fdc0c5b1f1a2f5992e52250dfa5f903cc2068ba007bd280f92\",\n \"1e6fcfadaacd23678c4708d3b006f9760feebdaff7f0903c012758a0c2dbecc8\",\n \"18479a93fc2d5acd7d71d596f27a5834b2b236b44219bb08f6ca06cf760b74f6\"\n ],\n \"threat_actors\": [\n \"muddywater\"\n ],\n \"references\": [\n \"153590cf5677a6ab5b5103382d41d4d8868a878a04104e86e936db63e4d186b8\"\n ],\n \"urls\": [\n \"http://abrahamseed.co.za/db_template.php\",\n \"http://absfinancialplanning.co.za/images/db_template.php\"\n ]\n}" + } + }, + "schema": { + "properties": { + "files": { + "items": { + "example": "f4156284935d45fdc0c5b1f1a2f5992e52250dfa5f903cc2068ba007bd280f92", "type": "string" }, - "reference": { + "type": "array" + }, + "references": { + "items": { + "example": "153590cf5677a6ab5b5103382d41d4d8868a878a04104e86e936db63e4d186b8", "type": "string" }, - "accounts": { - "type": "array", - "items": { - "type": "string" - } - }, - "user_language": { + "type": "array" + }, + "threat_actors": { + "items": { + "example": "muddywater", "type": "string" }, - "link": { + "type": "array" + }, + "urls": { + "items": { + "example": "http://abrahamseed.co.za/db_template.php", "type": "string" }, - "account_selection": { - "type": "boolean" - }, - "redirect_immediate": { - "type": "boolean" - } - }, - "required": [ - "id", - "created", - "redirect", - "status", - "institution_id", - "agreement", - "reference", - "accounts", - "user_language", - "link", - "account_selection", - "redirect_immediate" - ] - }, - "examples": { - "Example": { - "value": { - "id": "6b0465f3-002d-4bf5-bce0-67106854daa5", - "created": "2023-02-03T07:03:39.960302Z", - "redirect": "https://api.contiant/data/api/success", - "status": "LN", - "institution_id": "REVOLUT_REVOGB21", - "agreement": "5e33bd0e-f74b-4bd9-bb18-b2f61f37467b", - "reference": "ffca66b2-1c66-4a6a-a7ab-197e68d19d2b", - "accounts": [ - "9b75e017-2c36-465a-92d3-f96b63c23445", - "185f1037-f981-45db-a3a4-7b7d230e4fd5" - ], - "user_language": "en", - "link": "https://api.contiant.com/psd2/start/6b0465f3-002d-4bf5-bce0-67106854daa5/REVOLUT_REVOGB21", - "account_selection": false, - "redirect_immediate": false - } + "type": "array" } - } + }, + "type": "object" } } - } + }, + "description": "200" }, - "operationId": "get-accounts", - "description": "Get list of all accounts for given consumer and bank institution", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "referenceId", - "required": true, - "description": "Unique ID for request" - } - ], - "security": [ - { - "Token": [] - } - ] - } - }, - "/data/account/{accountID}/balances": { + "400": { + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{}" + } + }, + "schema": { + "properties": {}, + "type": "object" + } + } + }, + "description": "400" + } + }, + "security": [], + "summary": "Export IOCs from a vulnerability" + } + }, + "/collections/{id}/aggregations/download/{format}": { + "get": { + "tags": [ + "Vulnerabilities" + ], + "deprecated": false, + "description": "", + "operationId": "export-vulnerability-aggregations", "parameters": [ { + "description": "Your API key", + "in": "header", + "name": "x-apikey", + "required": true, "schema": { "type": "string" - }, - "name": "accountID", + } + }, + { + "description": "Vulnerability's ID", "in": "path", + "name": "id", "required": true, - "description": "ID of the account" - } - ], - "get": { - "summary": "Get Balances", - "tags": [ - "Data (AIS)" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "balances": { - "type": "array", - "items": { - "type": "object", - "properties": { - "balanceAmount": { - "type": "object", - "required": [ - "amount", - "currency" - ], - "properties": { - "amount": { - "type": "string" - }, - "currency": { - "type": "string" - } - } - }, - "balanceType": { - "type": "string" - }, - "referenceDate": { - "type": "string" - } - }, - "required": [ - "balanceAmount", - "balanceType", - "referenceDate" - ] - } - } - }, - "required": [ - "balances" - ] - }, - "examples": { - "Example": { - "value": { - "balances": [ - { - "balanceAmount": { - "amount": "50.00", - "currency": "EUR" - }, - "balanceType": "interimAvailable", - "referenceDate": "2022-10-05T00:00:00.000+00:00" - } - ] - } - } - } - } - } + "schema": { + "type": "string" } }, - "operationId": "get-balances", - "description": "Get balances for a given account", - "security": [ - { - "Token": [] - } - ], - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "referenceId", - "description": "Unique ID for request", - "required": true - } - ] - } - }, - "/data/account/{accountID}/transactions": { - "parameters": [ { + "description": "Export format (one of `json` or `csv`)", + "in": "path", + "name": "format", + "required": true, "schema": { "type": "string" - }, - "name": "accountID", - "in": "path", - "required": true + } } ], - "get": { - "summary": "Get Transactions", - "tags": [ - "Data (AIS)" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "transactions": { - "type": "object", - "required": [ - "booked", - "pending" - ], - "properties": { - "booked": { - "type": "array", - "items": { - "type": "object", - "properties": { - "transactionId": { - "type": "string" - }, - "bookingDate": { - "type": "string" - }, - "valueDate": { - "type": "string" - }, - "creditorName": { - "type": "string" - }, - "transactionAmount": { - "type": "object", - "required": [ - "amount", - "currency" - ], - "properties": { - "amount": { - "type": "string" - }, - "currency": { - "type": "string" - } - } - }, - "remittanceInformationUnstructuredArray": { - "type": "array", - "items": { - "type": "string" - } - }, - "proprietaryBankTransactionCode": { - "type": "string" - }, - "bookingDateTime": { - "type": "string" - }, - "valueDateTime": { - "type": "string" - } - }, - "required": [ - "transactionId", - "bookingDate", - "valueDate", - "creditorName", - "transactionAmount", - "remittanceInformationUnstructuredArray", - "proprietaryBankTransactionCode", - "bookingDateTime", - "valueDateTime" - ] - } - }, - "pending": { - "type": "array", - "items": { - "type": "object" - } - } - } - } - }, - "required": [ - "transactions" - ] - }, - "examples": { - "Example": { - "value": { - "transactions": { - "booked": [ - { - "transactionId": "52301aa3-5dad-4dfa-9b32-09788f04984f", - "bookingDate": "2023-01-20", - "valueDate": "2023-01-21", - "creditorName": "ACME", - "transactionAmount": { - "amount": "50.00", - "currency": "EUR" - }, - "remittanceInformationUnstructuredArray": [ - "Refund from ACME" - ], - "proprietaryBankTransactionCode": "CARD_REFUND", - "bookingDateTime": "2023-01-20T09:27:33.892807Z", - "valueDateTime": "2023-01-21T12:11:32.531049Z" - }, - { - "transactionId": "14c90bfe-690f-4784-b287-fa21a03eceb7", - "bookingDate": "2022-12-31", - "valueDate": "2023-01-04", - "creditorName": "ACME", - "transactionAmount": { - "amount": "-8.54", - "currency": "EUR" - }, - "remittanceInformationUnstructuredArray": [ - "Buying coffee" - ], - "proprietaryBankTransactionCode": "CARD_PAYMENT", - "bookingDateTime": "2022-12-31T23:06:32.034014Z", - "valueDateTime": "2023-01-04T02:42:22.622500Z" - } - ], - "pending": [] - } - } - } - } - } - } - } - }, - "operationId": "get-transactions-for-account", - "security": [ - { - "Token": [] - } - ], - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid" - }, - "in": "query", - "name": "referenceId", - "description": "Unique ID for request", - "required": true - } - ], - "description": "Get transactions for the specified Account ID" - } - }, - "/notifications/event-subscriptions": { - "post": { - "summary": "Create Event Subscription", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique ID for the event subscription" - }, - "eventTypeId": { - "type": "string", - "description": "Type of the event subscription", - "enum": [ - "payment.status" - ] - }, - "url": { - "type": "string", - "description": "URL where the notification will be sent" - }, - "secret": { - "type": "string", - "description": "Autogenerated secret that you will need to validate notifications sent to the provided url. Note that the secret will be accessible only when the event subscription is created" - }, - "createdAt": { - "type": "string", - "description": "Datetime in RFC 3339 without timezone, always in UTC" - }, - "updatedAt": { - "type": "string", - "description": "Datetime in RFC 3339 without timezone, always in UTC" - } - }, - "required": [ - "id", - "eventTypeId", - "url", - "secret", - "createdAt", - "updatedAt" - ] - } - }, - "examples": { - "Example": { - "value": { - "id": "8748ecfb-fc83-4586-ae04-111be33a34f6", - "eventTypeId": "payment.status", - "url": "https://example.com", - "secret": "secret", - "createdAt": "2023-11-01T19:14:52.188226Z", - "updatedAt": "2023-11-01T19:14:52.188226Z" - } - } + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n\t\"files\": {\n\t\t\"contacted_urls\": [\n\t\t\t{\n\t\t\t\t\"count\": 2,\n\t\t\t\t\"value\": \"http://ocsp.digicert.com/\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"count\": 2,\n\t\t\t\t\"value\": \"http://crl3.digicert.com/Omniroot2025.crl\"\n\t\t\t}\n ...\n\t\t],\n\t\t\"contacted_domains\": [\n\t\t\t{\n\t\t\t\t\"count\": 4,\n\t\t\t\t\"value\": \"nexusrules.officeapps.live.com\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"count\": 4,\n\t\t\t\t\"value\": \"officeclient.microsoft.com\"\n\t\t\t},\n ...\n\t\t],\n ...\n\t},\n ...\n}" } } } - } + }, + "description": "200" }, - "operationId": "create-event-subscription", - "description": "Create Notification Event Subscription", - "tags": [ - "Notifications" - ], - "security": [ - { - "Token": [] - } - ], - "requestBody": { + "400": { "content": { "application/json": { - "schema": { - "type": "object", - "properties": { - "eventTypeId": { - "type": "string", - "description": "Type of the event", - "enum": [ - "payment.status" - ] - }, - "url": { - "type": "string", - "description": "URL where the notification for the specified event will be sent" - } - }, - "required": [ - "eventTypeId", - "url" - ] - }, "examples": { - "Example": { - "value": { - "eventTypeId": "payment.status", - "url": "https://example.com" - } + "Result": { + "value": "{}" } + }, + "schema": { + "properties": {}, + "type": "object" } } - } + }, + "description": "400" } }, - "get": { - "summary": "Get Event Subscriptions", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "Unique ID for the event subscription" - }, - "eventTypeId": { - "type": "string", - "description": "Type of the event subscription", - "enum": [ - "payment.status" - ] - }, - "url": { - "type": "string", - "description": "URL where the notification will be sent" - }, - "createdAt": { - "type": "string", - "description": "Datetime in RFC 3339 without timezone, always in UTC" - }, - "updatedAt": { - "type": "string", - "description": "Datetime in RFC 3339 without timezone, always in UTC" - } - }, - "required": [ - "id", - "eventTypeId", - "url", - "createdAt", - "updatedAt" - ] - } - }, - "examples": { - "Example": { - "value": [ - { - "id": "8748ecfb-fc83-4586-ae04-111be33a34f6", - "eventTypeId": "payment.status", - "url": "https://example.com", - "createdAt": "2023-11-01T19:14:52.188226Z", - "updatedAt": "2023-11-01T19:14:52.188226Z" - } - ] - } - } - } - } + "security": [], + "summary": "Export aggregations / commonalities of a vulnerability" + } + }, + "/collections/{id}/{relationship}/download/{format}": { + "get": { + "tags": [ + "Vulnerabilities" + ], + "deprecated": false, + "description": "", + "operationId": "export-iocs-vulnerability-relationship", + "parameters": [ + { + "description": "Vulnerability's ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" } }, - "operationId": "get-event-subscriptions", - "description": "Get Event Subscriptions", - "tags": [ - "Notifications" - ], - "security": [ - { - "Token": [] - } - ] - } - }, - "/notifications/event-subscriptions/{id}": { - "parameters": [ { + "description": "Relationship name (see [table](ref:vulnerability-object#relationships))", + "in": "path", + "name": "relationship", + "required": true, "schema": { - "type": "string", - "format": "uuid" - }, - "name": "id", - "description": "Unique ID of the event subscription", + "type": "string" + } + }, + { + "description": "Export format (one of `json`, `csv`, or `stix`)", "in": "path", - "required": true - } - ], - "get": { - "summary": "Get Event Subscription", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "Unique ID for the event subscription" - }, - "eventTypeId": { - "type": "string", - "description": "Type of the event subscription", - "enum": [ - "payment.status" - ] - }, - "url": { - "type": "string", - "description": "URL where the notification will be sent" - }, - "createdAt": { - "type": "string", - "description": "Datetime in RFC 3339 without timezone, always in UTC" - }, - "updatedAt": { - "type": "string", - "description": "Datetime in RFC 3339 without timezone, always in UTC" - } - }, - "required": [ - "id", - "EventTypeId", - "url", - "createdAt", - "updatedAt" - ] - }, - "examples": { - "Example": { - "value": { - "id": "8748ecfb-fc83-4586-ae04-111be33a34f6", - "eventTypeId": "payment.status", - "url": "https://example.com", - "createdAt": "2023-11-01T19:14:52.188226Z", - "updatedAt": "2023-11-01T19:14:52.188226Z" - } - } - } - } - } + "name": "format", + "required": true, + "schema": { + "type": "string" } }, - "operationId": "get-event-subscription", - "description": "Get Event Subscription", - "tags": [ - "Notifications" - ], - "security": [ - { - "Token": [] + { + "description": "Your API key", + "in": "header", + "name": "x-apikey", + "required": true, + "schema": { + "type": "string" } - ] - }, - "patch": { - "summary": "Update Event Subscription", - "requestBody": { + } + ], + "responses": { + "200": { "content": { "application/json": { + "examples": { + "Result": { + "value": "{\n \"files\": [\n \"009cc0f34f60467552ef79c3892c501043c972be55fe936efb30584975d45ec0\",\n \"153117aa54492ca955b540ac0a8c21c1be98e9f7dd8636a36d73581ec1ddcf58\",\n \"18479a93fc2d5acd7d71d596f27a5834b2b236b44219bb08f6ca06cf760b74f6\"\n ]\n}" + } + }, "schema": { - "type": "object", "properties": { - "url": { - "type": "string", - "description": "URL where the notification for the specified event will be sent" + "files": { + "items": { + "example": "009cc0f34f60467552ef79c3892c501043c972be55fe936efb30584975d45ec0", + "type": "string" + }, + "type": "array" } }, - "required": [ - "url" - ] - }, - "examples": { - "Example": { - "value": { - "url": "https://notification.com" - } - } + "type": "object" } } - } + }, + "description": "200" }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "Unique ID for the event subscription" - }, - "eventTypeId": { - "type": "string", - "description": "Type of the event subscription", - "enum": [ - "payment.status" - ] - }, - "url": { - "type": "string", - "description": "URL where the notification will be sent" - }, - "createdAt": { - "type": "string", - "description": "Datetime in RFC 3339 without timezone, always in UTC" - }, - "updatedAt": { - "type": "string", - "description": "Datetime in RFC 3339 without timezone, always in UTC" - } - }, - "required": [ - "id", - "EventTypeId", - "url", - "createdAt", - "updatedAt" - ] - }, - "examples": { - "Example": { - "value": { - "id": "8748ecfb-fc83-4586-ae04-111be33a34f6", - "eventTypeId": "payment.status", - "url": "https://notification.com", - "createdAt": "2023-11-01T19:14:52.188226Z", - "updatedAt": "2023-11-01T19:15:52.188226Z" - } - } + "400": { + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{}" } + }, + "schema": { + "properties": {}, + "type": "object" } } - } - }, - "operationId": "update-event-subscription", - "description": "Update Event Subscription", - "tags": [ - "Notifications" - ], - "security": [ - { - "Token": [] - } - ] + }, + "description": "400" + } }, - "delete": { - "summary": "Delete Event Subscription", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "Unique ID for the event subscription" - }, - "eventTypeId": { - "type": "string", - "description": "Type of the event subscription", - "enum": [ - "payment.status" - ] - }, - "url": { - "type": "string", - "description": "URL where the notification will be sent" - }, - "createdAt": { - "type": "string", - "description": "Datetime in RFC 3339 without timezone, always in UTC" - }, - "updatedAt": { - "type": "string", - "description": "Datetime in RFC 3339 without timezone, always in UTC" - } - }, - "required": [ - "id", - "EventTypeId", - "url", - "createdAt", - "updatedAt" - ] - }, - "examples": { - "Example": { - "value": { - "id": "8748ecfb-fc83-4586-ae04-111be33a34f6", - "eventTypeId": "payment.status", - "url": "https://example.com", - "createdAt": "2023-11-01T19:14:52.188226Z", - "updatedAt": "2023-11-01T19:14:52.188226Z" - } - } - } - } - } - } - }, - "operationId": "delete-event-subscription", - "description": "Delete Event Subscription", - "tags": [ - "Notifications" - ], - "security": [ - { - "Token": [] - } - ] - } + "security": [], + "summary": "Export IOCs from a given vulnerability's relationship" } - }, - "x-readme": { - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true } - } \ No newline at end of file + }, + "security": [], + "servers": [ + { + "url": "https://www.virustotal.com/api/v3" + } + ], + "x-readme": { + "explorer-enabled": true, + "headers": [], + "proxy-enabled": false, + "samples-enabled": true + } +}