/ransomware/groups

POST /api/ransomware/groups

Price: 1 credit

Get a ransomware group profile: description, leak-site and chat locations with their availability, tools by category and MITRE ATT&CK tactics and techniques

How to use it

Take the group name from ransomware/groups/list; aliases are not resolved, so cl0p answers 412 while clop answers. Tools and TTPs are filled for a minority of groups.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• group string required — ransomware.live group name or the group page URL (examples: "akira", "https://www.ransomware.live/group/lockbit3"; minLength: 1; maxLength: 200)

Response

• @type string (default: "RansomwareGroup")
• alias string required
• url string required
• alternative_name string nullable
• description string nullable
• added_date string nullable
• locations array (default: [])
  • @type string (default: "RansomwareGroupLocation")
  • fqdn string required
  • url string nullable
  • location_type string nullable
  • is_available boolean nullable
  • is_enabled boolean nullable
• tools array (default: [])
  • @type string (default: "RansomwareToolCategory")
  • category string required
  • tools array (default: [])
• ttps array (default: [])
  • @type string (default: "RansomwareTactic")
  • tactic_id string required
  • name string nullable
  • techniques array (default: [])
    • @type string (default: "RansomwareTechnique")
    • technique_id string required
    • name string nullable
    • details string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — ransomware.live has no group under this name Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.