{ "opencollection": "1.0.0", "info": { "name": "ThreatDown Subscriptions API", "version": "1.0.0" }, "items": [ { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Get subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.threatdown.com/oneview/v1/sites/:id/subscriptions", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Valid OneView site ID (Ex. \"30616562663436302D643733312D346238622D623338332D613031343538363566383333\")" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get subscription data by site id." }, { "info": { "name": "Create subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.threatdown.com/oneview/v1/sites/:id/subscriptions", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Valid OneView site ID (Ex. \"30616562663436302D643733312D346238622D623338332D613031343538363566383333\")" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Use this endpoint to create a subscription for one of your manages site. After creating one subscription, your customer's data will be populated with an `account_id` field that you can use for security's management apis, like detections, endpoints and jobs.\n\n## Available catalog codes\n\n| Catalog Code | Description |\n| ---------------- | ------------------------------------------- |\n| BUS-CLOUD-IR-01 | ThreatDown Incident Response |\n| BUS-CLOUD-" }, { "info": { "name": "Update webhook subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.threatdown.com/oneview/v1/sites/:id/subscriptions", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Valid OneView site ID (Ex. \"30616562663436302D643733312D346238622D623338332D613031343538363566383333\")" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Use this endpoint to upgrade/downgrade or change term types or seats" }, { "info": { "name": "Delete a subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.threatdown.com/oneview/v1/sites/:id/subscriptions", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Valid OneView site ID (Ex. \"30616562663436302D643733312D346238622D623338332D613031343538363566383333\")" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete your site subscriptions. This will mark the subscription as expired" }, { "info": { "name": "Get all subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.threatdown.com/oneview/v1/sites/:id/subscriptions/all", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Valid OneView site ID (Ex. \"30616562663436302D643733312D346238622D623338332D613031343538363566383333\")" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all subscriptions data by site id." }, { "info": { "name": "Get entitlements", "type": "http" }, "http": { "method": "GET", "url": "https://api.threatdown.com/oneview/v1/subscriptions", "headers": [ { "name": "authorization", "value": "" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all entitlements" }, { "info": { "name": "Get usage", "type": "http" }, "http": { "method": "GET", "url": "https://api.threatdown.com/oneview/v1/subscriptions/quantity", "headers": [ { "name": "authorization", "value": "" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get information about the usage of sites" }, { "info": { "name": "Get report about your customer subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.threatdown.com/oneview/v1/subscriptions/report", "headers": [ { "name": "authorization", "value": "" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get information about your customer subscriptions" }, { "info": { "name": "[v2 - À la carte] Get account available subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.threatdown.com/oneview/v2/sites/subscriptions/availability", "headers": [ { "name": "authorization", "value": "" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Use this endpoint to retrieve the available subscriptions for a given MSP account\n\n## Field descriptions\n### products\n| Field name | Data type or example | Description |\n|----------------------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------|\n| product " }, { "info": { "name": "[v2 - À la carte] Get a site subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.threatdown.com/oneview/v2/sites/:id/subscriptions", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Valid OneView site ID (Ex. \"30616562663436302D643733312D346238622D623338332D613031343538363566383333\")" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get active subscriptions for an existing site." }, { "info": { "name": "[v2 - À la carte] Create a new subscription for a site", "type": "http" }, "http": { "method": "POST", "url": "https://api.threatdown.com/oneview/v2/sites/:id/subscriptions", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Valid OneView site ID (Ex. \"30616562663436302D643733312D346238622D623338332D613031343538363566383333\")" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Use this endpoint to create a subscription for one of your managed sites.\n\nAfter creating one subscription, your customer's data will be populated with an `account_id` field that you can use for security's management apis, like detections, endpoints and jobs.\n\n- This api can only be used when it does not have a current subscription\n- If a site was created through the OneView console, it will likely have a subscription already\n- If site has an active subscription, use the update subscription api\n" }, { "info": { "name": "[v2 - À la carte] Update a site's current subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.threatdown.com/oneview/v2/sites/:id/subscriptions", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Valid OneView site ID (Ex. \"30616562663436302D643733312D346238622D623338332D613031343538363566383333\")" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Use this endpoint to add or modify a current site subscription\n* The user may add or remove a trial through this api\n *

The user will not be able to re-add a trial once it has been removed

\n * Trials are limited to 100 seats\n* The user may only trial a higher tier product to an existing Paid subscription\n * If the user has a paid EP subscription, the user may add an EDR trial (assuming the MSP is entitled to EDR)\n * If the user has a paid EDR subscription, the user ma" }, { "info": { "name": "[v2 - À la carte] Extend a trial for a site", "type": "http" }, "http": { "method": "PUT", "url": "https://api.threatdown.com/oneview/v2/sites/:id/extend/:product", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Valid OneView site ID (Ex. \"30616562663436302D643733312D346238622D623338332D613031343538363566383333\")" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Extend a trial for an existing site.\n\nDespite 404s often being a non-recoverable error, on this endpoing, 404s are sometimes recoverable. In this case, setting a retry limit (for example 3 times) is suggested instead of not retrying when a 404 is received." }, { "info": { "name": "[v2 - À la carte] Get site's add-on subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.threatdown.com/oneview/v2/sites/:id/addOns", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Valid OneView site ID (Ex. \"30616562663436302D643733312D346238622D623338332D613031343538363566383333\")" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get active add-ons for an existing site" }, { "info": { "name": "[v2 - À la carte] Update a site's current add-on subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.threatdown.com/oneview/v2/sites/:id/addOns", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Valid OneView site ID (Ex. \"30616562663436302D643733312D346238622D623338332D613031343538363566383333\")" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Use this endpoint to add or modify a current site's add-on subscription\n* Please note the product values are not static\n* The product values are provided in the `availability` API under `add_ons` field\n* If the user would like to update the seat count, simply increase the values here\n\n## Request payload examples:\nUpdate a subscription with\n* ThreatDown DNS Filtering and 5 seats\n```\n[\n {\n \"product\": \"BUS-MBDNS-01\",\n \"term_type\": \"paid\",\n \"term_length\": 0,\n \"add_on_a" }, { "info": { "name": "[v3 - Bundles] Get account's available bundle subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.threatdown.com/oneview/v3/sites/subscriptions/availability", "headers": [ { "name": "authorization", "value": "" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Use this endpoint to retrieve the available **Bundle** subscriptions for a given MSP account\n\n## Field descriptions\n## Bundles\n| Field name | Data type or example | Description |\n|------------|----------------------|------------------------------------------------------------|\n| core | Allocation Object | Available seat allocation for `core` bundle per device |\n| advanced | Allocation Object | Available seat allocation for `advance" }, { "info": { "name": "[v3 - Bundles] Get site's bundle subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.threatdown.com/oneview/v3/sites/:id/subscriptions", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Valid OneView site ID (Ex. \"30616562663436302D643733312D346238622D623338332D613031343538363566383333\")" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Use this endpoint to fetch the subscription for one of your managed sites.\n\n### bundle\n\nDetermines the bundle for the subscription\n\n| value | Description |\n|----------|-----------------------------------|\n| core | Apply `core` bundle to a site |\n| advanced | Apply `advanced` bundle to a site |\n| elite | Apply `elite` bundle to a site |\n| ultimate | Apply `ultimate` bundle to a site |\n\n### auto_convert_trial_to_paid\n\nDetermines if a trial subscription will a" }, { "info": { "name": "[v3 - Bundles] Create or update a site's bundle subscriptions", "type": "http" }, "http": { "method": "POST", "url": "https://api.threatdown.com/oneview/v3/sites/:id/subscriptions", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Valid OneView site ID (Ex. \"30616562663436302D643733312D346238622D623338332D613031343538363566383333\")" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oneview/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Use this endpoint to create a subscription for one of your managed sites.\n\nAfter creating one subscription, your customer's data will be populated with an `account_id` field that you can use for security's management apis, like detections, endpoints and jobs.\n\n- This api can be used to both create a subscription and update a subscription\n- If a site was created through the OneView console, it will likely have a subscription already\n\nAvailable options will be provided by another api\n\n- https://on" } ] } ], "bundled": true }