Mandiant Collections API

Collections live under a project and are another foundational unit of organization in the ASM platform. They define the process of collecting entities, issues and technologies. All entities, issues and technologies live within one and only one collection (and its corresponding project).

Operations 6

GET /api/v1/user_collections Index #
POST /api/v1/user_collections Create #
GET /api/v1/user_collections/{uuid} Read #
DELETE /api/v1/user_collections/{uuid} Delete #
PATCH /api/v1/user_collections/{uuid}/archive Archive #
PATCH /api/v1/user_collections/{uuid}/unarchive Unarchive #

Documentation

Specifications

Schemas & Data

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/mandiant:mandiant-collections-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mandiant-collections-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Mandiant Collections API
  version: 1.0.6
  description: 'Operations tagged Collections across 2 of this provider''s published API definitions: mandiant-asm-openapi.yml, mandiant-asm-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://{{base_url}}
tags:
- name: Collections
  description: Collections live under a project and are another foundational unit of organization in the ASM platform. They define the process of collecting entities, issues and technologies. All entities, issues and technologies live within one and only one collection (and its corresponding project).
paths:
  /api/v1/user_collections:
    get:
      tags:
      - Collections
      summary: Index
      description: List all collections. if invalid, or no PROJECT_ID is passed, only collections from top project are returned.
      security:
      - noauthAuth: []
      parameters:
      - name: INTRIGUE_ACCESS_KEY
        in: header
        schema:
          type: string
        example: '{{intrigue_access_key}}'
      - name: INTRIGUE_SECRET_KEY
        in: header
        schema:
          type: string
        example: '{{intrigue_secret_key}}'
      - name: PROJECT_ID
        in: header
        schema:
          type: string
        description: 'Required: id from {{base_url}}/api/v1/projects'
        example: '{{project_id}}'
      responses:
        '200':
          description: OK
          headers:
            Date:
              schema:
                type: string
                example: Fri, 09 Sep 2022 16:57:24 GMT
            Content-Type:
              schema:
                type: string
                example: application/json
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Connection:
              schema:
                type: string
                example: keep-alive
            X-Content-Type-Options:
              schema:
                type: string
                example: nosniff
            Vary:
              schema:
                type: string
                example: Origin
            Via:
              schema:
                type: string
                example: 1.1 vegur
            CF-Cache-Status:
              schema:
                type: string
                example: DYNAMIC
            Report-To:
              schema:
                type: string
                example: '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=Xede4Yk68bG1B4jfDfuYebXyUGUmiICrwwp%2FXYhv8T%2Fs0Ef6CzOnBffKS2LIAyHQm7R87cV7S7%2BP1hcErLI6ljfWp0uqL3pTpXGVjGAuenxbVJiECvfxxcNVP73vhxuDlA%3D%3D"}],"group":"cf-nel","max_age":604800}'
            NEL:
              schema:
                type: string
                example: '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
            Server:
              schema:
                type: string
                example: cloudflare
            CF-RAY:
              schema:
                type: string
                example: 74817676a8f886fc-ORD
            Content-Encoding:
              schema:
                type: string
                example: br
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
                message: User collections
                result:
                - id: 132956
                  uuid: c1b502fe-1020-4a85-a620-e02614526ee9
                  type: user_collection
                  name: attacksurface_mw3tdwq
                  following: null
                  auto_refresh_schedule: daily
                  workflow_name: null
                  printable_name: Attacksurface_APP_QA
                  tags: []
                  last_updated: '2022-09-09T16:48:13.000Z'
                  created_at: '2022-08-18T16:10:20.930Z'
                  deleted: false
                  deleted_at: null
                  deleted_by: null
                  local_icon_path: /branding/icons/org.png
                  entity_count: 1
                  new_entity_count: 1
                  total_entity_count: 16
                  issues_by_severity:
                    '4': 1
                    '5': 3
                  notify_emails_new_entities: null
                  notify_webhooks_new_entities: null
                  pointer_collection_id: null
                  pointer_collection_uuid: null
                  config: null
                  refreshing: false
                  project_id: 6797
                  project_uuid: be884e25-a0bb-4836-a836-df5eab176186
                  project_name: ASMQA_AttackSurfaceAPP
                  owner_id: 6797
                  owner_uuid: be884e25-a0bb-4836-a836-df5eab176186
                  owner_type: project
                  owner_name: ASMQA_AttackSurfaceAPP
                  role: admin
      operationId: getApiV1UserCollections
      x-operation-id-source: derived
    post:
      tags:
      - Collections
      summary: Create
      description: 'Create a new collection.

        - workflow_name:

        - external_discovery_and_assessment

        - authenticated_cloud_discovery

        - code_repository_discovery_and_assessment

        - suspicious_domain_discovery

        - mobile_app_discovery

        - external_application_assessment

        - third_party_workflow'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: Test Collection
                workflow_name: external_discovery_and_assessment
      security:
      - noauthAuth: []
      parameters:
      - name: INTRIGUE_ACCESS_KEY
        in: header
        schema:
          type: string
        example: '{{intrigue_access_key}}'
      - name: INTRIGUE_SECRET_KEY
        in: header
        schema:
          type: string
        example: '{{intrigue_secret_key}}'
      - name: PROJECT_ID
        in: header
        schema:
          type: string
        description: 'Required: id from {{base_url}}/api/v1/projects'
        example: '{{project_id}}'
      responses:
        '200':
          description: OK
          headers:
            Server:
              schema:
                type: string
                example: Cowboy
            Date:
              schema:
                type: string
                example: Fri, 17 Feb 2023 22:42:58 GMT
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Type:
              schema:
                type: string
                example: application/json
            X-Content-Type-Options:
              schema:
                type: string
                example: nosniff
            Vary:
              schema:
                type: string
                example: Origin
            Content-Length:
              schema:
                type: integer
                example: '966'
            Via:
              schema:
                type: string
                example: 1.1 vegur
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
                message: Collection created!
                result:
                  id: 139738
                  uuid: a161bde5-4611-43b2-b32a-9d8d8f8d62aa
                  type: user_collection
                  name: testcollection_ygkbmec
                  following: null
                  auto_refresh_schedule: daily
                  workflow_name: external_discovery_and_assessment
                  workflow_pretty_name: External Discovery & Assessment
                  printable_name: Test collection
                  global_labels: []
                  last_updated: '2018-01-01T00:00:00.000Z'
                  created_at: '2023-02-17T22:42:52.655Z'
                  deleted: false
                  deleted_at: null
                  deleted_by: null
                  local_icon_path: /branding/icons/org.png
                  entity_count: 0
                  new_entity_count: 0
                  total_entity_count: 0
                  issues_by_severity:
                    '0': 0
                    '1': 0
                    '2': 0
                    '3': 0
                    '4': 0
                    '5': 0
                  notify_emails_new_entities: null
                  notify_webhooks_new_entities: null
                  pointer_collection_id: null
                  pointer_collection_uuid: null
                  config:
                    ingest:
                      disabled_check_names: null
                    strict_scoping: true
                  refreshing: null
                  queue: null
                  project_id: 1234
                  project_uuid: be884e25-a0bb-4836-a836-df5eab176186
                  project_name: Project_Name
                  owner_id: 1234
                  owner_uuid: be884e25-a0bb-4836-a836-df5eab176186
                  owner_type: project
                  owner_name: Project_name
      operationId: postApiV1UserCollections
      x-operation-id-source: derived
    servers:
    - url: http://{{base_url}}
  /api/v1/user_collections/{uuid}:
    get:
      tags:
      - Collections
      summary: Read
      description: Show details for a specified collection
      parameters:
      - name: INTRIGUE_ACCESS_KEY
        in: header
        schema:
          type: string
        example: '{{intrigue_access_key}}'
      - name: INTRIGUE_SECRET_KEY
        in: header
        schema:
          type: string
        example: '{{intrigue_secret_key}}'
      - name: uuid
        in: path
        schema:
          type: string
        required: true
        description: uuid from {{base_url}}/api/v1/user_collections
        example: a161bde5-4611-43b2-b32a-9d8d8f8d62aa
      responses:
        undefined:
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
                message: Collection retrieved!
                result:
                  id: 132956
                  uuid: c1b502fe-1020-4a85-a620-e02614526ee9
                  type: user_collection
                  name: collectionname_mw3tdwq
                  following: null
                  auto_refresh_schedule: daily
                  workflow_name: null
                  printable_name: Collection Name
                  tags: []
                  last_updated: '2022-09-09T05:56:21.000Z'
                  created_at: '2022-08-18T16:10:20.930Z'
                  deleted: false
                  deleted_at: null
                  deleted_by: null
                  local_icon_path: /branding/icons/org.png
                  entity_count: 0
                  new_entity_count: 0
                  total_entity_count: 14
                  issues_by_severity:
                    '4': 1
                    '5': 3
                  notify_emails_new_entities: null
                  notify_webhooks_new_entities: null
                  pointer_collection_id: null
                  pointer_collection_uuid: null
                  config: null
                  refreshing: false
                  project_id: 1234
                  project_uuid: be884e25-a0bb-4836-a836-df5eab176186
                  project_name: Project Name
                  owner_id: 1234
                  owner_uuid: be884e25-a0bb-4836-a836-df5eab176186
                  owner_type: project
                  owner_name: Project_name
                  role: admin
      operationId: getApiV1UserCollectionsByUuid
      x-operation-id-source: derived
    delete:
      tags:
      - Collections
      summary: Delete
      description: Delete a collection
      parameters:
      - name: INTRIGUE_ACCESS_KEY
        in: header
        schema:
          type: string
        example: '{{intrigue_access_key}}'
      - name: INTRIGUE_SECRET_KEY
        in: header
        schema:
          type: string
        example: '{{intrigue_secret_key}}'
      - name: uuid
        in: path
        schema:
          type: string
        required: true
        description: uuid from {{base_url}}/api/v1/user_collections
      responses:
        undefined:
          content:
            text/plain:
              schema:
                type: string
              example: "{\n    \"success\": true,\n    \"message\": \"Collection permanently deleted!\",\n    \"result\": true\n}"
      operationId: deleteApiV1UserCollectionsByUuid
      x-operation-id-source: derived
    servers:
    - url: http://{{base_url}}
  /api/v1/user_collections/{uuid}/archive:
    patch:
      tags:
      - Collections
      summary: Archive
      description: Archive a collection
      requestBody:
        content: {}
      parameters:
      - name: INTRIGUE_ACCESS_KEY
        in: header
        schema:
          type: string
        example: '{{intrigue_access_key}}'
      - name: INTRIGUE_SECRET_KEY
        in: header
        schema:
          type: string
        example: '{{intrigue_secret_key}}'
      - name: uuid
        in: path
        schema:
          type: string
        required: true
        description: 'Required: id from {{base_url}}/api/v1/projects'
      responses:
        undefined:
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
                message: Collection archived
                result: true
      operationId: patchApiV1UserCollectionsByUuidArchive
      x-operation-id-source: derived
    servers:
    - url: http://{{base_url}}
  /api/v1/user_collections/{uuid}/unarchive:
    patch:
      tags:
      - Collections
      summary: Unarchive
      description: Unarchive a collection
      requestBody:
        content: {}
      parameters:
      - name: INTRIGUE_ACCESS_KEY
        in: header
        schema:
          type: string
        example: '{{intrigue_access_key}}'
      - name: INTRIGUE_SECRET_KEY
        in: header
        schema:
          type: string
        example: '{{intrigue_secret_key}}'
      - name: uuid
        in: path
        schema:
          type: string
        required: true
        description: uuid from {{base_url}}/api/v1/user_collections
      responses:
        undefined:
          content:
            application/json:
              schema:
                type: object
              example:
                success: false
                message: Collection unarchived
                result: null
      operationId: patchApiV1UserCollectionsByUuidUnarchive
      x-operation-id-source: derived
    servers:
    - url: http://{{base_url}}
components:
  securitySchemes:
    noauthAuth:
      type: http
      scheme: noauth
x-refined-from:
- mandiant-asm-openapi.yml
- mandiant-asm-openapi.yml