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/cycognito-scope-management-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  version: 0.0.1
  title: CyCognito API V1 Reference Scope Management API
  description: The CyCognito API V1 is a REST API that allows you to post and get data from our main data entities—assets and issues.
tags:
- name: Scope Management
paths:
  /v1/include-assets:
    post:
      description: 'Bulk addition of new assets to your attack surface, with details such as value, asset type, organization, propagation preference, and optional description).

        *Note:* To attribute an asset to multiple organizations, you will need to create separate list entries.'
      security:
      - apiAuth: []
      summary: Include new assets
      tags:
      - Scope Management
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  asset-type:
                    description: 'Specifies the category of the asset.

                      *Supported values:* `ip`, `domain`, `cert`, `webapp`, `iprange`.'
                    type: string
                  description:
                    description: A short description of the significance of the asset.
                    type: string
                  organization:
                    description: The name of an organization to attribute the asset to.
                    type: string
                  propagate:
                    description: Indicates whether the inclusion should propagate to other assets.
                    type: boolean
                  tags:
                    description: A comma-separated list of custom keywords or phrases added as metadata to an asset or issue by a user, which can be used to navigate, filter, and group assets and issues.
                    type: array
                    items:
                      type: string
                  value:
                    description: The name of the asset to be included, formatted in accordance with its asset type.
                    type: string
                required:
                - asset-type
                - organization
                - value
              example: "[\n  {\n    \"asset_type\": \"ip\",\n    \"description\": \"An IP that was recently acquired\",\n    \"organization\": \"Acme Corporation\",\n    \"propagate\": true,\n    \"tags\": [\"Assigned to Team A\",\"Owned by Jim\"],\n    \"value\": \"1.1.1.1\"\n  },\n  {\n    \"asset_type\": \"ip\",\n    \"description\": \"An IP that was recently acquired\",\n    \"organization\": \"Acme Homes\",\n    \"propagate\": true,\n    \"tags\": \"Assigned to Team B\",\n    \"value\": \"1.1.1.2\"\n  },\n  {\n    \"asset_type\": \"domain\",\n    \"description\": \"A domain that was recently acquired\",\n    \"organization\": \"Acme Studio\",\n    \"propagate\": true,\n    \"tags\": \"Assigned to Team A\",\n    \"value\": \"studio.acme.com\"\n  },\n  {\n    \"asset_type\": \"ip-range\",\n    \"description\": \"We recently acquired the IPs in this range\",\n    \"organization\": \"Acme Corporation\",\n    \"propagate\": true,\n    \"tags\": \"Owned by Jim\",\n    \"value\": \"1.1.1.1-1.1.1.2\"\n  }\n]"
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    description: 'Represents the outcome of the asset inclusion request. When the response status is 200, status is *success*. When the response status is 400, status is *failed*. '
                    type: string
                    example: success
                  errors:
                    description: A list detailing any errors encountered during the process. When the response status is 200, this list is empty, indicating no errors occurred. When the response status is 400, this list contains the specific error messages.
                    type: array
                    items:
                      type: string
                    example: The domain cannot be included at this time. To proceed, either remove this domain from your inclusion request, or contact support to assist you with including it manually.
                required:
                - status
                - errors
      operationId: postV1IncludeAssets
      x-operation-id-source: derived
components:
  securitySchemes:
    apiAuth:
      type: apiKey
      name: Authorization
      in: header