openapi: 3.1.0 info: version: 3.0.0 title: Escape Public Asm Assets API description: 'This API enables you to operate [Escape](https://escape.tech/) programmatically. All requests must be authenticated with a valid API key, provided in the `X-ESCAPE-API-KEY` header. For example: `X-ESCAPE-API-KEY: YOUR_API_KEY`. You can find your API key in the [Escape dashboard](https://app.escape.tech/user/).' servers: - url: https://public.escape.tech/v3 security: - apiKey: [] tags: - name: Assets description: 'Manage every discovered Assets. The public API provide basic CRUDs operations for all available assets. See [our documentation](https://docs.escape.tech/documentation/asm/asset-management/) for more details.' paths: /assets: get: tags: - Assets summary: List assets operationId: listAssets description: List and search assets of the organization. parameters: - schema: type: string description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5 required: false description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of items to return per page example: 50 required: false description: The number of items to return per page name: size in: query - schema: type: string enum: - DOMAIN - ENDPOINTS_COUNT - FIRST_SEEN - LAST_SEEN - NAME - PORTS - SEVERITY - TYPE - USED_BY_COUNT description: The type to sort by required: false description: The type to sort by name: sortType in: query - schema: type: string enum: - asc - desc default: asc description: The direction to sort by required: false description: The direction to sort by name: sortDirection in: query - schema: type: string example: asset1 description: Search term to filter assets by name or description required: false description: Search term to filter assets by name or description name: search in: query - schema: type: array items: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON description: Filter by type required: false description: Filter by type name: types in: query - schema: type: array items: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: Filter by status required: false description: Filter by status name: statuses in: query - schema: type: string enum: - 'true' - 'false' example: 'true' description: Filter by manually created required: false description: Filter by manually created name: manuallyCreated in: query responses: '200': description: OK content: application/json: schema: type: object properties: nextCursor: type: - string - 'null' totalCount: type: integer default: 100 example: 20 data: type: array items: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY description: The class of the asset type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON description: The type of the asset name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset owners: type: array items: type: string format: email description: Email addresses of the owners of this asset. service: type: - object - 'null' properties: url: type: string description: The url of the asset service type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET description: The type of the asset service required: - url - type title: AssetServiceSummarized description: The service of the asset frontend: type: - object - 'null' properties: url: type: string description: The url of the asset frontend type: type: string enum: - WEBAPP description: The type of the asset frontend required: - url - type title: AssetFrontendSummarized description: The frontend of the asset host: type: - object - 'null' properties: address: type: string description: The address of the asset host type: type: string enum: - DNS - IPV4 - IPV6 description: The type of the asset host required: - address - type title: AssetHostSummarized description: The host of the asset links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - service - frontend - host - links title: AssetSummarized description: Summarized information about an asset required: - nextCursor - data '400': description: Pagination error content: application/json: schema: type: object properties: message: type: string enum: - Invalid cursor details: type: string required: - message - details title: PaginationError description: Returned when an invalid pagination cursor is supplied /assets/bulk-update: post: tags: - Assets summary: Bulk update assets operationId: bulkUpdateAssets description: Update tags, projects, or status of multiple assets matching a filter predicate. requestBody: content: application/json: schema: type: object properties: where: type: object properties: assetIds: type: array items: type: string description: Filter by asset IDs types: type: array items: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON description: Filter by asset types statuses: type: array items: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: Filter by asset statuses tagIds: type: array items: type: string description: Tag IDs to assign projectIds: type: array items: type: string description: Project IDs to assign status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: New status to apply required: - where responses: '200': description: OK content: application/json: schema: type: object properties: success: type: boolean required: - success '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/bulk-delete: post: tags: - Assets summary: Bulk delete assets operationId: bulkDeleteAssets description: Schedule multiple assets matching a filter predicate for deletion. requestBody: content: application/json: schema: type: object properties: where: type: object properties: assetIds: type: array items: type: string description: Filter by asset IDs types: type: array items: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON description: Filter by asset types statuses: type: array items: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: Filter by asset statuses required: - where responses: '200': description: OK content: application/json: schema: type: object properties: success: type: boolean required: - success '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/{assetId}: get: tags: - Assets summary: Get an asset operationId: getAsset description: Get an asset by ID parameters: - schema: type: string description: The asset ID example: 00000000-0000-0000-0000-000000000000 required: true description: The asset ID name: assetId in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links title: AssetDetailed description: Detailed information about an asset '404': description: Not found content: application/json: schema: type: object properties: message: type: string enum: - Not found required: - message title: NotFound description: Returned when the requested resource does not exist put: tags: - Assets summary: Update an asset operationId: updateAsset description: Update an asset by ID parameters: - schema: type: string description: The asset ID example: 00000000-0000-0000-0000-000000000000 required: true description: The asset ID name: assetId in: path requestBody: description: Body of the request to update an asset content: application/json: schema: type: object properties: tagIds: anyOf: - type: string - type: array items: type: string description: The tag IDs of the asset example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 owners: anyOf: - type: string - type: array items: type: string description: The owners of the asset projectIds: type: array items: type: string format: uuid description: The project IDs of the asset example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 framework: type: string enum: - FRONTEND_ANGULAR - FRONTEND_DJANGO - FRONTEND_JAVASCRIPT - FRONTEND_JQUERY - FRONTEND_REACT - FRONTEND_SVELTE - FRONTEND_VUE - GRAPHQL_APOLLO - GRAPHQL_GRAPHQLYOGA - REST_ASP_NET - REST_CLOJURE - REST_DJANGO - REST_EXPRESS_JS - REST_FASTAPI - REST_FLASK - REST_GIN - REST_HONO - REST_LARAVEL - REST_NESTJS - REST_NEXTJS - REST_NUXTJS - REST_RUBY_ON_RAILS - REST_SCALA_PLAY - REST_SPRING_BOOT - REST_SYMFONY - UNKNOWN description: The framework of the asset status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset description: type: string description: The description of the asset example: Updated asset description name: type: - string - 'null' description: The custom name of the asset. If not provided, the default name will be used. example: Customer API example: framework: REST_DJANGO status: DEPRECATED description: Updated asset description name: Customer API responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '404': description: Not found content: application/json: schema: type: object properties: message: type: string enum: - Not found required: - message title: NotFound description: Returned when the requested resource does not exist delete: tags: - Assets summary: Delete an asset operationId: deleteAsset description: Delete an asset by ID parameters: - schema: type: string description: The asset ID example: 00000000-0000-0000-0000-000000000000 required: true description: The asset ID name: assetId in: path responses: '200': description: OK content: application/json: schema: type: object properties: message: type: string required: - message '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '404': description: Not found content: application/json: schema: type: object properties: message: type: string enum: - Not found required: - message title: NotFound description: Returned when the requested resource does not exist /assets/{assetId}/activities: get: tags: - Assets summary: List activities of an asset operationId: listAssetActivities description: List activities related to a specific asset. parameters: - schema: type: string format: uuid description: The asset ID example: 00000000-0000-0000-0000-000000000000 required: true description: The asset ID name: assetId in: path responses: '200': description: OK content: application/json: schema: type: array items: type: object properties: author: type: - object - 'null' properties: id: type: string description: The id of the author email: type: string description: The email of the author required: - id - email title: AuthorSummarized description: Summarized information about an author id: type: string format: uuid description: The id of the activity createdAt: type: string description: The date and time the activity was created kind: type: string enum: - ASSET_FOUND - ASSET_IGNORED - ASSET_UPDATED - COMMENT - ISSUE_FOUND - ISSUE_STATUS_CHANGED - OWNERS_NOTIFIED - SCHEMA_LINKED - SCHEMA_UNLINKED required: - author - id - createdAt - kind title: ActivitySummarized description: Summarized information about an activity '404': description: Not found content: application/json: schema: type: object properties: message: type: string enum: - Not found required: - message title: NotFound description: Returned when the requested resource does not exist post: tags: - Assets summary: Comment on an asset operationId: createAssetComment description: Add a comment to an asset. parameters: - schema: type: string format: uuid description: The asset ID example: 00000000-0000-0000-0000-000000000000 required: true description: The asset ID name: assetId in: path requestBody: content: application/json: schema: type: object properties: comment: type: string minLength: 1 maxLength: 512 description: Comment text; maximum 512 characters required: - comment responses: '200': description: OK content: application/json: schema: type: object properties: author: type: - object - 'null' properties: id: type: string description: The id of the author email: type: string description: The email of the author required: - id - email title: AuthorSummarized description: Summarized information about an author id: type: string format: uuid description: The id of the activity createdAt: type: string description: The date and time the activity was created kind: type: string enum: - ASSET_FOUND - ASSET_IGNORED - ASSET_UPDATED - COMMENT - ISSUE_FOUND - ISSUE_STATUS_CHANGED - OWNERS_NOTIFIED - SCHEMA_LINKED - SCHEMA_UNLINKED required: - author - id - createdAt - kind '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string enum: - Internal Server Error details: type: string required: - message - details title: InternalServerError description: Returned when the server fails to fulfil the request /assets/dns: post: tags: - Assets summary: Create asset dns operationId: createAsset_DNS description: Create a dns requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' description: The custom name of the asset. If not provided, the default name will be used. example: My Asset asset_class: type: string enum: - HOST extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - DNS address: type: string favicon: type: - string - 'null' open_ports: type: - array - 'null' items: type: object properties: port: type: number protocols: type: array items: type: string enum: - SSH - HTTP - HTTP2 - HTTPS - PSQL - MYSQL - MSSQL location_ids: type: - array - 'null' items: type: string required: - port - protocols ports_insights: type: - array - 'null' items: type: number paths_insights: type: - array - 'null' items: type: object properties: path: type: string method: type: string enum: - CONNECT - DELETE - GET - HEAD - OPTIONS - PATCH - POST - PUT - TRACE parameters: type: - object - 'null' properties: parameters: type: - array - 'null' items: type: object properties: name: type: string in: type: string enum: - path - query - header - cookie required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowedReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' content: type: - object - 'null' additionalProperties: type: object properties: schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' encoding: type: - object - 'null' additionalProperties: type: object properties: contentType: type: - string - 'null' style: type: - string - 'null' headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' required: - name - in requestBody: type: - object - 'null' properties: required: type: - boolean - 'null' description: type: - string - 'null' content: type: - object - 'null' additionalProperties: type: object properties: schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' encoding: type: - object - 'null' additionalProperties: type: object properties: contentType: type: - string - 'null' style: type: - string - 'null' headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' returnType: type: - object - 'null' properties: responses: type: - object - 'null' additionalProperties: type: object properties: description: type: string headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' content: type: - object - 'null' additionalProperties: type: object properties: schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' encoding: type: - object - 'null' additionalProperties: type: object properties: contentType: type: - string - 'null' style: type: - string - 'null' headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' required: - description required: - path - method private: type: - boolean - 'null' third_party: type: - string - 'null' enum: - ADMINER - BACULA - BAREOS - CONFLUENCE - DOVECOT - DRONE - ELK_STACK - FREEAPI - GHOST - GITEA - GITHUB - GITLAB - GLUU_SERVER - GRAFANA - JENKINS - JIRA - KEYCLOAK - LEMONLDAP - MAILCOW - MATTERMOST - METABASE - MONGODB - MYSQL - NEXTCLOUD - OPENVPN - OWNCLOUD - PHP - PORTAINER - POSTFIX - POSTGRESQL - PROMETHEUS - RANCHER - REDMINE - RESTIC - ROCKET_CHAT - SEAFILE - SENTRY - SONAR - TAIGA - TEAMCITY - VAULT - WIREGUARD - WORDPRESS - ZULIP - SPLUNK - AIRFLOW - APIGEE - null dns_records: type: - array - 'null' items: type: object properties: name: type: string type: type: string ttl: type: number data: type: string required: - name - type - ttl - data ips: type: - array - 'null' items: type: string region_country_codes: type: - array - 'null' items: type: string registrar: type: - string - 'null' required: - asset_class - asset_type - address example: asset_class: HOST asset_type: DNS address: example.com responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/ipv4: post: tags: - Assets summary: Create asset ipv4 operationId: createAsset_IPV4 description: Create a ipv4 requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' description: The custom name of the asset. If not provided, the default name will be used. example: My Asset asset_class: type: string enum: - HOST extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - IPV4 address: type: string favicon: type: - string - 'null' open_ports: type: - array - 'null' items: type: object properties: port: type: number protocols: type: array items: type: string enum: - SSH - HTTP - HTTP2 - HTTPS - PSQL - MYSQL - MSSQL location_ids: type: - array - 'null' items: type: string required: - port - protocols ports_insights: type: - array - 'null' items: type: number paths_insights: type: - array - 'null' items: type: object properties: path: type: string method: type: string enum: - CONNECT - DELETE - GET - HEAD - OPTIONS - PATCH - POST - PUT - TRACE parameters: type: - object - 'null' properties: parameters: type: - array - 'null' items: type: object properties: name: type: string in: type: string enum: - path - query - header - cookie required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowedReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' content: type: - object - 'null' additionalProperties: type: object properties: schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' encoding: type: - object - 'null' additionalProperties: type: object properties: contentType: type: - string - 'null' style: type: - string - 'null' headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' required: - name - in requestBody: type: - object - 'null' properties: required: type: - boolean - 'null' description: type: - string - 'null' content: type: - object - 'null' additionalProperties: type: object properties: schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' encoding: type: - object - 'null' additionalProperties: type: object properties: contentType: type: - string - 'null' style: type: - string - 'null' headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' returnType: type: - object - 'null' properties: responses: type: - object - 'null' additionalProperties: type: object properties: description: type: string headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' content: type: - object - 'null' additionalProperties: type: object properties: schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' encoding: type: - object - 'null' additionalProperties: type: object properties: contentType: type: - string - 'null' style: type: - string - 'null' headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' required: - description required: - path - method private: type: - boolean - 'null' third_party: type: - string - 'null' enum: - ADMINER - BACULA - BAREOS - CONFLUENCE - DOVECOT - DRONE - ELK_STACK - FREEAPI - GHOST - GITEA - GITHUB - GITLAB - GLUU_SERVER - GRAFANA - JENKINS - JIRA - KEYCLOAK - LEMONLDAP - MAILCOW - MATTERMOST - METABASE - MONGODB - MYSQL - NEXTCLOUD - OPENVPN - OWNCLOUD - PHP - PORTAINER - POSTFIX - POSTGRESQL - PROMETHEUS - RANCHER - REDMINE - RESTIC - ROCKET_CHAT - SEAFILE - SENTRY - SONAR - TAIGA - TEAMCITY - VAULT - WIREGUARD - WORDPRESS - ZULIP - SPLUNK - AIRFLOW - APIGEE - null organization: type: - string - 'null' country: type: - string - 'null' required: - asset_class - asset_type - address example: asset_class: HOST asset_type: IPV4 address: 192.168.1.1 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/ipv6: post: tags: - Assets summary: Create asset ipv6 operationId: createAsset_IPV6 description: Create a ipv6 requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' description: The custom name of the asset. If not provided, the default name will be used. example: My Asset asset_class: type: string enum: - HOST extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - IPV6 address: type: string favicon: type: - string - 'null' open_ports: type: - array - 'null' items: type: object properties: port: type: number protocols: type: array items: type: string enum: - SSH - HTTP - HTTP2 - HTTPS - PSQL - MYSQL - MSSQL location_ids: type: - array - 'null' items: type: string required: - port - protocols ports_insights: type: - array - 'null' items: type: number paths_insights: type: - array - 'null' items: type: object properties: path: type: string method: type: string enum: - CONNECT - DELETE - GET - HEAD - OPTIONS - PATCH - POST - PUT - TRACE parameters: type: - object - 'null' properties: parameters: type: - array - 'null' items: type: object properties: name: type: string in: type: string enum: - path - query - header - cookie required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowedReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' content: type: - object - 'null' additionalProperties: type: object properties: schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' encoding: type: - object - 'null' additionalProperties: type: object properties: contentType: type: - string - 'null' style: type: - string - 'null' headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' required: - name - in requestBody: type: - object - 'null' properties: required: type: - boolean - 'null' description: type: - string - 'null' content: type: - object - 'null' additionalProperties: type: object properties: schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' encoding: type: - object - 'null' additionalProperties: type: object properties: contentType: type: - string - 'null' style: type: - string - 'null' headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' returnType: type: - object - 'null' properties: responses: type: - object - 'null' additionalProperties: type: object properties: description: type: string headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' content: type: - object - 'null' additionalProperties: type: object properties: schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' encoding: type: - object - 'null' additionalProperties: type: object properties: contentType: type: - string - 'null' style: type: - string - 'null' headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' required: - description required: - path - method private: type: - boolean - 'null' third_party: type: - string - 'null' enum: - ADMINER - BACULA - BAREOS - CONFLUENCE - DOVECOT - DRONE - ELK_STACK - FREEAPI - GHOST - GITEA - GITHUB - GITLAB - GLUU_SERVER - GRAFANA - JENKINS - JIRA - KEYCLOAK - LEMONLDAP - MAILCOW - MATTERMOST - METABASE - MONGODB - MYSQL - NEXTCLOUD - OPENVPN - OWNCLOUD - PHP - PORTAINER - POSTFIX - POSTGRESQL - PROMETHEUS - RANCHER - REDMINE - RESTIC - ROCKET_CHAT - SEAFILE - SENTRY - SONAR - TAIGA - TEAMCITY - VAULT - WIREGUARD - WORDPRESS - ZULIP - SPLUNK - AIRFLOW - APIGEE - null organization: type: - string - 'null' country: type: - string - 'null' required: - asset_class - asset_type - address example: asset_class: HOST asset_type: IPV6 address: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/graphql: post: tags: - Assets summary: Create asset graphql operationId: createAsset_GRAPHQL description: Create a graphql requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' description: The custom name of the asset. If not provided, the default name will be used. example: My Asset asset_class: type: string enum: - API_SERVICE extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - GRAPHQL url: type: string favicon: type: - string - 'null' reachable_via: type: - array - 'null' items: type: string reachable_via_external_proxy: type: - boolean - 'null' private: type: - boolean - 'null' private_location_id: type: - string - 'null' environment: type: - string - 'null' enum: - DEVELOPMENT - STAGING - PRODUCTION - null cloud_provider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - VERCEL - UNKNOWN - null waf_provider: type: - string - 'null' enum: - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - YUNJIASU - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - WP_CERBER_SECURITY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - ACE_XML_GATEWAY - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - FIREPASS - TRAFFICSHIELD - FASTLY - FORTIWEB - AZURE_FRONT_DOOR - GODADDY_WEBSITE_PROTECTION - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - DATAPOWER - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KS_WAF - KONA_SITEDEFENDER - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - DATADOME - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - APPWALL - REBLAZE - RSFIREWALL - ASP_NET_WAF - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURE_ENTRY - EEYE_SECUREIIS - SECURESPHERE - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - UTM_WEB_PROTECTION - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRANSIP_WEB_FIREWALL - UEWAF - URLMASTER_SECURITYCHECK - URLSCAN - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - RAYWAF - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNSUO - YXLINK - ZENEDGE - ZSCALER - GOOGLE_CLOUD_APP_ARMOR - UNKNOWN - null auth_protocol: type: - string - 'null' enum: - BASIC - API_KEY - DIGEST - OAUTH - MTLS - SAML - LDAP - OIDC - HMAC - UNKNOWN - null auth_technology: type: - string - 'null' enum: - AUTH0 - COGNITO - KEYCLOAK - AWS_IAM - AZURE_ACTIVE_DIRECTORY - UNKNOWN - null third_party: type: - string - 'null' enum: - ADMINER - BACULA - BAREOS - CONFLUENCE - DOVECOT - DRONE - ELK_STACK - FREEAPI - GHOST - GITEA - GITHUB - GITLAB - GLUU_SERVER - GRAFANA - JENKINS - JIRA - KEYCLOAK - LEMONLDAP - MAILCOW - MATTERMOST - METABASE - MONGODB - MYSQL - NEXTCLOUD - OPENVPN - OWNCLOUD - PHP - PORTAINER - POSTFIX - POSTGRESQL - PROMETHEUS - RANCHER - REDMINE - RESTIC - ROCKET_CHAT - SEAFILE - SENTRY - SONAR - TAIGA - TEAMCITY - VAULT - WIREGUARD - WORDPRESS - ZULIP - SPLUNK - AIRFLOW - APIGEE - null ips: type: - array - 'null' items: type: string region_country_codes: type: - array - 'null' items: type: string framework: type: - string - 'null' enum: - GRAPHQL_APOLLO - GRAPHQL_GRAPHQLYOGA - null operations: type: - array - 'null' items: type: object properties: name: type: string type: type: string parameters: type: - array - 'null' items: type: object properties: name: type: string type: type: string required: - name - type returnType: type: - string - 'null' required: - name - type required: - asset_class - asset_type - url example: asset_class: API_SERVICE asset_type: GRAPHQL url: https://api.example.com/graphql responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/rest: post: tags: - Assets summary: Create asset rest operationId: createAsset_REST description: Create a rest requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' description: The custom name of the asset. If not provided, the default name will be used. example: My Asset asset_class: type: string enum: - API_SERVICE extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - REST url: type: string favicon: type: - string - 'null' reachable_via: type: - array - 'null' items: type: string reachable_via_external_proxy: type: - boolean - 'null' private: type: - boolean - 'null' private_location_id: type: - string - 'null' environment: type: - string - 'null' enum: - DEVELOPMENT - STAGING - PRODUCTION - null cloud_provider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - VERCEL - UNKNOWN - null waf_provider: type: - string - 'null' enum: - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - YUNJIASU - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - WP_CERBER_SECURITY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - ACE_XML_GATEWAY - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - FIREPASS - TRAFFICSHIELD - FASTLY - FORTIWEB - AZURE_FRONT_DOOR - GODADDY_WEBSITE_PROTECTION - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - DATAPOWER - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KS_WAF - KONA_SITEDEFENDER - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - DATADOME - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - APPWALL - REBLAZE - RSFIREWALL - ASP_NET_WAF - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURE_ENTRY - EEYE_SECUREIIS - SECURESPHERE - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - UTM_WEB_PROTECTION - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRANSIP_WEB_FIREWALL - UEWAF - URLMASTER_SECURITYCHECK - URLSCAN - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - RAYWAF - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNSUO - YXLINK - ZENEDGE - ZSCALER - GOOGLE_CLOUD_APP_ARMOR - UNKNOWN - null auth_protocol: type: - string - 'null' enum: - BASIC - API_KEY - DIGEST - OAUTH - MTLS - SAML - LDAP - OIDC - HMAC - UNKNOWN - null auth_technology: type: - string - 'null' enum: - AUTH0 - COGNITO - KEYCLOAK - AWS_IAM - AZURE_ACTIVE_DIRECTORY - UNKNOWN - null third_party: type: - string - 'null' enum: - ADMINER - BACULA - BAREOS - CONFLUENCE - DOVECOT - DRONE - ELK_STACK - FREEAPI - GHOST - GITEA - GITHUB - GITLAB - GLUU_SERVER - GRAFANA - JENKINS - JIRA - KEYCLOAK - LEMONLDAP - MAILCOW - MATTERMOST - METABASE - MONGODB - MYSQL - NEXTCLOUD - OPENVPN - OWNCLOUD - PHP - PORTAINER - POSTFIX - POSTGRESQL - PROMETHEUS - RANCHER - REDMINE - RESTIC - ROCKET_CHAT - SEAFILE - SENTRY - SONAR - TAIGA - TEAMCITY - VAULT - WIREGUARD - WORDPRESS - ZULIP - SPLUNK - AIRFLOW - APIGEE - null ips: type: - array - 'null' items: type: string region_country_codes: type: - array - 'null' items: type: string framework: type: - string - 'null' enum: - REST_DJANGO - REST_FLASK - REST_FASTAPI - REST_EXPRESS_JS - REST_SPRING_BOOT - REST_RUBY_ON_RAILS - REST_ASP_NET - REST_LARAVEL - REST_NESTJS - REST_SCALA_PLAY - REST_CLOJURE - REST_SYMFONY - REST_GIN - REST_HONO - REST_NEXTJS - REST_NUXTJS - null endpoints: type: - array - 'null' items: type: object properties: path: type: string method: type: string enum: - CONNECT - DELETE - GET - HEAD - OPTIONS - PATCH - POST - PUT - TRACE parameters: type: - object - 'null' properties: parameters: type: - array - 'null' items: type: object properties: name: type: string in: type: string enum: - path - query - header - cookie required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowedReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' content: type: - object - 'null' additionalProperties: type: object properties: schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' encoding: type: - object - 'null' additionalProperties: type: object properties: contentType: type: - string - 'null' style: type: - string - 'null' headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' required: - name - in requestBody: type: - object - 'null' properties: required: type: - boolean - 'null' description: type: - string - 'null' content: type: - object - 'null' additionalProperties: type: object properties: schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' encoding: type: - object - 'null' additionalProperties: type: object properties: contentType: type: - string - 'null' style: type: - string - 'null' headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' returnType: type: - object - 'null' properties: responses: type: - object - 'null' additionalProperties: type: object properties: description: type: string headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' content: type: - object - 'null' additionalProperties: type: object properties: schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' encoding: type: - object - 'null' additionalProperties: type: object properties: contentType: type: - string - 'null' style: type: - string - 'null' headers: type: - object - 'null' additionalProperties: type: object properties: required: type: - boolean - 'null' deprecated: type: - boolean - 'null' description: type: - string - 'null' style: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' schema: type: - object - 'null' additionalProperties: {} example: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' examples: type: - object - 'null' additionalProperties: type: object properties: summary: type: - string - 'null' description: type: - string - 'null' value: anyOf: - type: object additionalProperties: {} - type: array items: {} - type: string - type: number - type: number - type: boolean - type: 'null' externalValue: type: - string - 'null' explode: type: - boolean - 'null' allowReserved: type: - boolean - 'null' required: - description required: - path - method openapi_url: type: - string - 'null' required: - asset_class - asset_type - url example: asset_class: API_SERVICE asset_type: REST url: https://api.example.com/v1 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/grpc: post: tags: - Assets summary: Create asset grpc operationId: createAsset_GRPC description: Create a grpc requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' description: The custom name of the asset. If not provided, the default name will be used. example: My Asset asset_class: type: string enum: - API_SERVICE extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - GRPC url: type: string favicon: type: - string - 'null' reachable_via: type: - array - 'null' items: type: string reachable_via_external_proxy: type: - boolean - 'null' private: type: - boolean - 'null' private_location_id: type: - string - 'null' environment: type: - string - 'null' enum: - DEVELOPMENT - STAGING - PRODUCTION - null cloud_provider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - VERCEL - UNKNOWN - null waf_provider: type: - string - 'null' enum: - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - YUNJIASU - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - WP_CERBER_SECURITY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - ACE_XML_GATEWAY - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - FIREPASS - TRAFFICSHIELD - FASTLY - FORTIWEB - AZURE_FRONT_DOOR - GODADDY_WEBSITE_PROTECTION - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - DATAPOWER - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KS_WAF - KONA_SITEDEFENDER - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - DATADOME - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - APPWALL - REBLAZE - RSFIREWALL - ASP_NET_WAF - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURE_ENTRY - EEYE_SECUREIIS - SECURESPHERE - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - UTM_WEB_PROTECTION - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRANSIP_WEB_FIREWALL - UEWAF - URLMASTER_SECURITYCHECK - URLSCAN - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - RAYWAF - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNSUO - YXLINK - ZENEDGE - ZSCALER - GOOGLE_CLOUD_APP_ARMOR - UNKNOWN - null auth_protocol: type: - string - 'null' enum: - BASIC - API_KEY - DIGEST - OAUTH - MTLS - SAML - LDAP - OIDC - HMAC - UNKNOWN - null auth_technology: type: - string - 'null' enum: - AUTH0 - COGNITO - KEYCLOAK - AWS_IAM - AZURE_ACTIVE_DIRECTORY - UNKNOWN - null third_party: type: - string - 'null' enum: - ADMINER - BACULA - BAREOS - CONFLUENCE - DOVECOT - DRONE - ELK_STACK - FREEAPI - GHOST - GITEA - GITHUB - GITLAB - GLUU_SERVER - GRAFANA - JENKINS - JIRA - KEYCLOAK - LEMONLDAP - MAILCOW - MATTERMOST - METABASE - MONGODB - MYSQL - NEXTCLOUD - OPENVPN - OWNCLOUD - PHP - PORTAINER - POSTFIX - POSTGRESQL - PROMETHEUS - RANCHER - REDMINE - RESTIC - ROCKET_CHAT - SEAFILE - SENTRY - SONAR - TAIGA - TEAMCITY - VAULT - WIREGUARD - WORDPRESS - ZULIP - SPLUNK - AIRFLOW - APIGEE - null ips: type: - array - 'null' items: type: string region_country_codes: type: - array - 'null' items: type: string required: - asset_class - asset_type - url example: asset_class: API_SERVICE asset_type: GRPC url: grpc://api.example.com:50051 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/websocket: post: tags: - Assets summary: Create asset websocket operationId: createAsset_WEBSOCKET description: Create a websocket requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' description: The custom name of the asset. If not provided, the default name will be used. example: My Asset asset_class: type: string enum: - API_SERVICE extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - WEBSOCKET url: type: string favicon: type: - string - 'null' reachable_via: type: - array - 'null' items: type: string reachable_via_external_proxy: type: - boolean - 'null' private: type: - boolean - 'null' private_location_id: type: - string - 'null' environment: type: - string - 'null' enum: - DEVELOPMENT - STAGING - PRODUCTION - null cloud_provider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - VERCEL - UNKNOWN - null waf_provider: type: - string - 'null' enum: - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - YUNJIASU - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - WP_CERBER_SECURITY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - ACE_XML_GATEWAY - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - FIREPASS - TRAFFICSHIELD - FASTLY - FORTIWEB - AZURE_FRONT_DOOR - GODADDY_WEBSITE_PROTECTION - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - DATAPOWER - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KS_WAF - KONA_SITEDEFENDER - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - DATADOME - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - APPWALL - REBLAZE - RSFIREWALL - ASP_NET_WAF - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURE_ENTRY - EEYE_SECUREIIS - SECURESPHERE - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - UTM_WEB_PROTECTION - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRANSIP_WEB_FIREWALL - UEWAF - URLMASTER_SECURITYCHECK - URLSCAN - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - RAYWAF - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNSUO - YXLINK - ZENEDGE - ZSCALER - GOOGLE_CLOUD_APP_ARMOR - UNKNOWN - null auth_protocol: type: - string - 'null' enum: - BASIC - API_KEY - DIGEST - OAUTH - MTLS - SAML - LDAP - OIDC - HMAC - UNKNOWN - null auth_technology: type: - string - 'null' enum: - AUTH0 - COGNITO - KEYCLOAK - AWS_IAM - AZURE_ACTIVE_DIRECTORY - UNKNOWN - null third_party: type: - string - 'null' enum: - ADMINER - BACULA - BAREOS - CONFLUENCE - DOVECOT - DRONE - ELK_STACK - FREEAPI - GHOST - GITEA - GITHUB - GITLAB - GLUU_SERVER - GRAFANA - JENKINS - JIRA - KEYCLOAK - LEMONLDAP - MAILCOW - MATTERMOST - METABASE - MONGODB - MYSQL - NEXTCLOUD - OPENVPN - OWNCLOUD - PHP - PORTAINER - POSTFIX - POSTGRESQL - PROMETHEUS - RANCHER - REDMINE - RESTIC - ROCKET_CHAT - SEAFILE - SENTRY - SONAR - TAIGA - TEAMCITY - VAULT - WIREGUARD - WORDPRESS - ZULIP - SPLUNK - AIRFLOW - APIGEE - null ips: type: - array - 'null' items: type: string region_country_codes: type: - array - 'null' items: type: string required: - asset_class - asset_type - url responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/mcp: post: tags: - Assets summary: Create asset mcp operationId: createAsset_MCP description: Create a mcp requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' description: The custom name of the asset. If not provided, the default name will be used. example: My Asset asset_class: type: string enum: - API_SERVICE extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - MCP url: type: string favicon: type: - string - 'null' reachable_via: type: - array - 'null' items: type: string reachable_via_external_proxy: type: - boolean - 'null' private: type: - boolean - 'null' private_location_id: type: - string - 'null' environment: type: - string - 'null' enum: - DEVELOPMENT - STAGING - PRODUCTION - null cloud_provider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - VERCEL - UNKNOWN - null waf_provider: type: - string - 'null' enum: - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - YUNJIASU - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - WP_CERBER_SECURITY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - ACE_XML_GATEWAY - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - FIREPASS - TRAFFICSHIELD - FASTLY - FORTIWEB - AZURE_FRONT_DOOR - GODADDY_WEBSITE_PROTECTION - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - DATAPOWER - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KS_WAF - KONA_SITEDEFENDER - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - DATADOME - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - APPWALL - REBLAZE - RSFIREWALL - ASP_NET_WAF - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURE_ENTRY - EEYE_SECUREIIS - SECURESPHERE - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - UTM_WEB_PROTECTION - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRANSIP_WEB_FIREWALL - UEWAF - URLMASTER_SECURITYCHECK - URLSCAN - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - RAYWAF - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNSUO - YXLINK - ZENEDGE - ZSCALER - GOOGLE_CLOUD_APP_ARMOR - UNKNOWN - null auth_protocol: type: - string - 'null' enum: - BASIC - API_KEY - DIGEST - OAUTH - MTLS - SAML - LDAP - OIDC - HMAC - UNKNOWN - null auth_technology: type: - string - 'null' enum: - AUTH0 - COGNITO - KEYCLOAK - AWS_IAM - AZURE_ACTIVE_DIRECTORY - UNKNOWN - null third_party: type: - string - 'null' enum: - ADMINER - BACULA - BAREOS - CONFLUENCE - DOVECOT - DRONE - ELK_STACK - FREEAPI - GHOST - GITEA - GITHUB - GITLAB - GLUU_SERVER - GRAFANA - JENKINS - JIRA - KEYCLOAK - LEMONLDAP - MAILCOW - MATTERMOST - METABASE - MONGODB - MYSQL - NEXTCLOUD - OPENVPN - OWNCLOUD - PHP - PORTAINER - POSTFIX - POSTGRESQL - PROMETHEUS - RANCHER - REDMINE - RESTIC - ROCKET_CHAT - SEAFILE - SENTRY - SONAR - TAIGA - TEAMCITY - VAULT - WIREGUARD - WORDPRESS - ZULIP - SPLUNK - AIRFLOW - APIGEE - null ips: type: - array - 'null' items: type: string region_country_codes: type: - array - 'null' items: type: string required: - asset_class - asset_type - url responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/soap: post: tags: - Assets summary: Create asset soap operationId: createAsset_SOAP description: Create a soap requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' description: The custom name of the asset. If not provided, the default name will be used. example: My Asset asset_class: type: string enum: - API_SERVICE extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - SOAP url: type: string favicon: type: - string - 'null' reachable_via: type: - array - 'null' items: type: string reachable_via_external_proxy: type: - boolean - 'null' private: type: - boolean - 'null' private_location_id: type: - string - 'null' environment: type: - string - 'null' enum: - DEVELOPMENT - STAGING - PRODUCTION - null cloud_provider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - VERCEL - UNKNOWN - null waf_provider: type: - string - 'null' enum: - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - YUNJIASU - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - WP_CERBER_SECURITY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - ACE_XML_GATEWAY - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - FIREPASS - TRAFFICSHIELD - FASTLY - FORTIWEB - AZURE_FRONT_DOOR - GODADDY_WEBSITE_PROTECTION - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - DATAPOWER - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KS_WAF - KONA_SITEDEFENDER - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - DATADOME - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - APPWALL - REBLAZE - RSFIREWALL - ASP_NET_WAF - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURE_ENTRY - EEYE_SECUREIIS - SECURESPHERE - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - UTM_WEB_PROTECTION - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRANSIP_WEB_FIREWALL - UEWAF - URLMASTER_SECURITYCHECK - URLSCAN - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - RAYWAF - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNSUO - YXLINK - ZENEDGE - ZSCALER - GOOGLE_CLOUD_APP_ARMOR - UNKNOWN - null auth_protocol: type: - string - 'null' enum: - BASIC - API_KEY - DIGEST - OAUTH - MTLS - SAML - LDAP - OIDC - HMAC - UNKNOWN - null auth_technology: type: - string - 'null' enum: - AUTH0 - COGNITO - KEYCLOAK - AWS_IAM - AZURE_ACTIVE_DIRECTORY - UNKNOWN - null third_party: type: - string - 'null' enum: - ADMINER - BACULA - BAREOS - CONFLUENCE - DOVECOT - DRONE - ELK_STACK - FREEAPI - GHOST - GITEA - GITHUB - GITLAB - GLUU_SERVER - GRAFANA - JENKINS - JIRA - KEYCLOAK - LEMONLDAP - MAILCOW - MATTERMOST - METABASE - MONGODB - MYSQL - NEXTCLOUD - OPENVPN - OWNCLOUD - PHP - PORTAINER - POSTFIX - POSTGRESQL - PROMETHEUS - RANCHER - REDMINE - RESTIC - ROCKET_CHAT - SEAFILE - SENTRY - SONAR - TAIGA - TEAMCITY - VAULT - WIREGUARD - WORDPRESS - ZULIP - SPLUNK - AIRFLOW - APIGEE - null ips: type: - array - 'null' items: type: string region_country_codes: type: - array - 'null' items: type: string required: - asset_class - asset_type - url responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/webapp: post: tags: - Assets summary: Create asset webapp operationId: createAsset_WEBAPP description: Create a webapp requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' description: The custom name of the asset. If not provided, the default name will be used. example: My Asset asset_class: type: string enum: - FRONTEND extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - WEBAPP url: type: string favicon: type: - string - 'null' reachable_via: type: - array - 'null' items: type: string reachable_via_external_proxy: type: - boolean - 'null' private: type: - boolean - 'null' private_location_id: type: - string - 'null' framework: type: - string - 'null' enum: - FRONTEND_REACT - FRONTEND_VUE - FRONTEND_ANGULAR - FRONTEND_SVELTE - FRONTEND_JQUERY - FRONTEND_JAVASCRIPT - FRONTEND_DJANGO - null environment: type: - string - 'null' enum: - DEVELOPMENT - STAGING - PRODUCTION - null cloud_provider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - VERCEL - UNKNOWN - null waf_provider: type: - string - 'null' enum: - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - YUNJIASU - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - WP_CERBER_SECURITY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - ACE_XML_GATEWAY - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - FIREPASS - TRAFFICSHIELD - FASTLY - FORTIWEB - AZURE_FRONT_DOOR - GODADDY_WEBSITE_PROTECTION - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - DATAPOWER - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KS_WAF - KONA_SITEDEFENDER - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - DATADOME - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - APPWALL - REBLAZE - RSFIREWALL - ASP_NET_WAF - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURE_ENTRY - EEYE_SECUREIIS - SECURESPHERE - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - UTM_WEB_PROTECTION - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRANSIP_WEB_FIREWALL - UEWAF - URLMASTER_SECURITYCHECK - URLSCAN - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - RAYWAF - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNSUO - YXLINK - ZENEDGE - ZSCALER - GOOGLE_CLOUD_APP_ARMOR - UNKNOWN - null captcha_provider: type: - string - 'null' enum: - RECAPTCHA - HCAPTCHA - CLOUDFLARE_TURNSTILE - GEETEST - FRIENDLY_CAPTCHA - AWS_WAF_CAPTCHA - MTCAPTCHA - YANDEX_SMARTCAPTCHA - ARCAPTCHA - ALTCHA - FUNCAPTCHA - SLIDER_CAPTCHA - PICATCHA - SNAPHOST - STARTEST - ADCAPTCHA - V4GUARD_CHECKPOINT - COINHIVE_CAPTCHA - RINGCAPTCHA - REALLY_SIMPLE_CAPTCHA - OTHER - null auth_protocol: type: - string - 'null' enum: - BASIC - API_KEY - DIGEST - OAUTH - MTLS - SAML - LDAP - OIDC - HMAC - UNKNOWN - null auth_technology: type: - string - 'null' enum: - AUTH0 - COGNITO - KEYCLOAK - AWS_IAM - AZURE_ACTIVE_DIRECTORY - UNKNOWN - null third_party: type: - string - 'null' enum: - ADMINER - BACULA - BAREOS - CONFLUENCE - DOVECOT - DRONE - ELK_STACK - FREEAPI - GHOST - GITEA - GITHUB - GITLAB - GLUU_SERVER - GRAFANA - JENKINS - JIRA - KEYCLOAK - LEMONLDAP - MAILCOW - MATTERMOST - METABASE - MONGODB - MYSQL - NEXTCLOUD - OPENVPN - OWNCLOUD - PHP - PORTAINER - POSTFIX - POSTGRESQL - PROMETHEUS - RANCHER - REDMINE - RESTIC - ROCKET_CHAT - SEAFILE - SENTRY - SONAR - TAIGA - TEAMCITY - VAULT - WIREGUARD - WORDPRESS - ZULIP - SPLUNK - AIRFLOW - APIGEE - null ips: type: - array - 'null' items: type: string region_country_codes: type: - array - 'null' items: type: string login_page: type: - object - 'null' properties: login: type: string enum: - none - optional - mandatory login_type: type: array items: type: string enum: - username - email - phone - sso login_page_url: type: - string - 'null' can_register: type: boolean register_page_url: type: - string - 'null' sso_providers: type: array items: type: string required: - login - login_type - can_register - sso_providers required: - asset_class - asset_type - url example: asset_class: FRONTEND asset_type: WEBAPP url: https://app.example.com responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/azure-tenant: post: tags: - Assets summary: Create asset azure-tenant operationId: createAsset_AZURE_TENANT description: Create a azure-tenant requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' asset_class: type: string enum: - CLOUD_HOSTING extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - AZURE_TENANT immutable_key: type: string client_id: type: string client_secret: type: string tenant_id: type: string required: - asset_class - asset_type - immutable_key - client_id - client_secret - tenant_id responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/ipv4-range: post: tags: - Assets summary: Create asset ipv4-range operationId: createAsset_IPV4_RANGE description: Create a ipv4-range requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' description: The custom name of the asset. If not provided, the default name will be used. example: My Asset asset_class: type: string enum: - NETWORK extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - IPV4_RANGE cidr: type: string private: type: - boolean - 'null' private_location_id: type: - string - 'null' required: - asset_class - asset_type - cidr responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/gitlab-repository: post: tags: - Assets summary: Create asset gitlab-repository operationId: createAsset_GITLAB_REPOSITORY description: Create a gitlab-repository requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' asset_class: type: string enum: - REPOSITORY extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - GITLAB_REPOSITORY url: type: string http_url_to_repo: type: - string - 'null' description: type: - string - 'null' location_id: type: - string - 'null' default_branch: type: - string - 'null' blob_base_url: type: - string - 'null' last_commit: type: - object - 'null' properties: sha: type: string timestamp_iso: type: string required: - sha - timestamp_iso owners: type: - array - 'null' items: type: object properties: email: type: string required: - email languages: type: - array - 'null' items: type: string enum: - PYTHON - JAVASCRIPT - TYPESCRIPT - JAVA - C - CPP - CSHARP - RUST - PHP - RUBY - SWIFT - KOTLIN - GO group_id: type: - number - 'null' group_full_path: type: - string - 'null' group_web_url: type: - string - 'null' project_id: type: - number - 'null' archived: type: - boolean - 'null' visibility: type: - string - 'null' enum: - PRIVATE - INTERNAL - PUBLIC - null group: type: - object - 'null' properties: asset_class: type: string enum: - SOURCE_CODE_MANAGEMENT extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - GITLAB_GROUP name: type: - string - 'null' immutable_key: type: string api_key: type: string instance_url: type: - string - 'null' location_id: type: - string - 'null' required: - asset_class - asset_type - immutable_key - api_key required: - asset_class - asset_type - url responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/github-repository: post: tags: - Assets summary: Create asset github-repository operationId: createAsset_GITHUB_REPOSITORY description: Create a github-repository requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' asset_class: type: string enum: - REPOSITORY extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - GITHUB_REPOSITORY url: type: string http_url_to_repo: type: - string - 'null' description: type: - string - 'null' location_id: type: - string - 'null' default_branch: type: - string - 'null' blob_base_url: type: - string - 'null' last_commit: type: - object - 'null' properties: sha: type: string timestamp_iso: type: string required: - sha - timestamp_iso owners: type: - array - 'null' items: type: object properties: email: type: string required: - email languages: type: - array - 'null' items: type: string enum: - PYTHON - JAVASCRIPT - TYPESCRIPT - JAVA - C - CPP - CSHARP - RUST - PHP - RUBY - SWIFT - KOTLIN - GO owner_id: type: - number - 'null' owner_login: type: - string - 'null' owner_html_url: type: - string - 'null' fork: type: - boolean - 'null' archived: type: - boolean - 'null' disabled: type: - boolean - 'null' clonable: type: - boolean - 'null' private: type: - boolean - 'null' org: type: - object - 'null' properties: asset_class: type: string enum: - SOURCE_CODE_MANAGEMENT extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - GITHUB_ORGANIZATION name: type: - string - 'null' immutable_key: type: string api_key: type: string location_id: type: - string - 'null' required: - asset_class - asset_type - immutable_key - api_key required: - asset_class - asset_type - url responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/bitbucket-repository: post: tags: - Assets summary: Create asset bitbucket-repository operationId: createAsset_BITBUCKET_REPOSITORY description: Create a bitbucket-repository requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' asset_class: type: string enum: - REPOSITORY extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - BITBUCKET_REPOSITORY url: type: string http_url_to_repo: type: - string - 'null' description: type: - string - 'null' location_id: type: - string - 'null' default_branch: type: - string - 'null' blob_base_url: type: - string - 'null' last_commit: type: - object - 'null' properties: sha: type: string timestamp_iso: type: string required: - sha - timestamp_iso owners: type: - array - 'null' items: type: object properties: email: type: string required: - email languages: type: - array - 'null' items: type: string enum: - PYTHON - JAVASCRIPT - TYPESCRIPT - JAVA - C - CPP - CSHARP - RUST - PHP - RUBY - SWIFT - KOTLIN - GO workspace_name: type: - string - 'null' repository_name: type: - string - 'null' is_private: type: - boolean - 'null' org: type: - object - 'null' properties: asset_class: type: string enum: - SOURCE_CODE_MANAGEMENT extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - BITBUCKET_ORGANIZATION name: type: - string - 'null' immutable_key: type: string email: type: string api_key: type: string workspace_slug: type: string location_id: type: - string - 'null' required: - asset_class - asset_type - immutable_key - email - api_key - workspace_slug required: - asset_class - asset_type - url responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/code-project: post: tags: - Assets summary: Create asset code-project operationId: createAsset_CODE_PROJECT description: Create a code-project requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' asset_class: type: string enum: - CODE_PROJECT extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - CODE_PROJECT repository: oneOf: - type: object properties: asset_class: type: string enum: - REPOSITORY extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - GITLAB_REPOSITORY url: type: string name: type: - string - 'null' http_url_to_repo: type: - string - 'null' description: type: - string - 'null' location_id: type: - string - 'null' default_branch: type: - string - 'null' blob_base_url: type: - string - 'null' last_commit: type: - object - 'null' properties: sha: type: string timestamp_iso: type: string required: - sha - timestamp_iso owners: type: - array - 'null' items: type: object properties: email: type: string required: - email languages: type: - array - 'null' items: type: string enum: - PYTHON - JAVASCRIPT - TYPESCRIPT - JAVA - C - CPP - CSHARP - RUST - PHP - RUBY - SWIFT - KOTLIN - GO group_id: type: - number - 'null' group_full_path: type: - string - 'null' group_web_url: type: - string - 'null' project_id: type: - number - 'null' archived: type: - boolean - 'null' visibility: type: - string - 'null' enum: - PRIVATE - INTERNAL - PUBLIC - null group: type: - object - 'null' properties: asset_class: type: string enum: - SOURCE_CODE_MANAGEMENT extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - GITLAB_GROUP name: type: - string - 'null' immutable_key: type: string api_key: type: string instance_url: type: - string - 'null' location_id: type: - string - 'null' required: - asset_class - asset_type - immutable_key - api_key required: - asset_class - asset_type - url - type: object properties: asset_class: type: string enum: - REPOSITORY extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - GITHUB_REPOSITORY url: type: string name: type: - string - 'null' http_url_to_repo: type: - string - 'null' description: type: - string - 'null' location_id: type: - string - 'null' default_branch: type: - string - 'null' blob_base_url: type: - string - 'null' last_commit: type: - object - 'null' properties: sha: type: string timestamp_iso: type: string required: - sha - timestamp_iso owners: type: - array - 'null' items: type: object properties: email: type: string required: - email languages: type: - array - 'null' items: type: string enum: - PYTHON - JAVASCRIPT - TYPESCRIPT - JAVA - C - CPP - CSHARP - RUST - PHP - RUBY - SWIFT - KOTLIN - GO owner_id: type: - number - 'null' owner_login: type: - string - 'null' owner_html_url: type: - string - 'null' fork: type: - boolean - 'null' archived: type: - boolean - 'null' disabled: type: - boolean - 'null' clonable: type: - boolean - 'null' private: type: - boolean - 'null' org: type: - object - 'null' properties: asset_class: type: string enum: - SOURCE_CODE_MANAGEMENT extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - GITHUB_ORGANIZATION name: type: - string - 'null' immutable_key: type: string api_key: type: string location_id: type: - string - 'null' required: - asset_class - asset_type - immutable_key - api_key required: - asset_class - asset_type - url - type: object properties: asset_class: type: string enum: - REPOSITORY extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - BITBUCKET_REPOSITORY url: type: string name: type: - string - 'null' http_url_to_repo: type: - string - 'null' description: type: - string - 'null' location_id: type: - string - 'null' default_branch: type: - string - 'null' blob_base_url: type: - string - 'null' last_commit: type: - object - 'null' properties: sha: type: string timestamp_iso: type: string required: - sha - timestamp_iso owners: type: - array - 'null' items: type: object properties: email: type: string required: - email languages: type: - array - 'null' items: type: string enum: - PYTHON - JAVASCRIPT - TYPESCRIPT - JAVA - C - CPP - CSHARP - RUST - PHP - RUBY - SWIFT - KOTLIN - GO workspace_name: type: - string - 'null' repository_name: type: - string - 'null' is_private: type: - boolean - 'null' org: type: - object - 'null' properties: asset_class: type: string enum: - SOURCE_CODE_MANAGEMENT extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - BITBUCKET_ORGANIZATION name: type: - string - 'null' immutable_key: type: string email: type: string api_key: type: string workspace_slug: type: string location_id: type: - string - 'null' required: - asset_class - asset_type - immutable_key - email - api_key - workspace_slug required: - asset_class - asset_type - url path: type: string language: type: string enum: - PYTHON - JAVASCRIPT - TYPESCRIPT - JAVA - C - CPP - CSHARP - RUST - PHP - RUBY - SWIFT - KOTLIN - GO http_url_to_project: type: - string - 'null' owners: type: - array - 'null' items: type: object properties: email: type: string required: - email last_commit: type: - object - 'null' properties: sha: type: string timestamp_iso: type: string required: - sha - timestamp_iso required: - asset_class - asset_type - repository - path - language responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/aws-lambda: post: tags: - Assets summary: Create asset aws-lambda operationId: createAsset_AWS_LAMBDA description: Create a aws-lambda requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: string asset_class: type: string enum: - CLOUD_COMPONENT extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - AWS_LAMBDA function_arn: type: string runtime: type: - string - 'null' description: type: - string - 'null' function_url: type: - string - 'null' required: - name - asset_class - asset_type - function_arn responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/package: post: tags: - Assets summary: Create asset package operationId: createAsset_PACKAGE description: Create a package requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' description: The custom name of the asset. If not provided, the default name will be used. example: My Asset asset_class: type: string enum: - TECHNOLOGY extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - PACKAGE technology_key: type: string version: type: - string - 'null' reference_url: type: - string - 'null' cpe: type: - string - 'null' cpe_guessed: type: - boolean - 'null' well_known_technology: type: - string - 'null' enum: - REDIS - NGINX - APACHE - REACT - ANGULAR - VUE - SVELTE - null description: type: - string - 'null' purl: type: string package_type: type: string enum: - ALPM - APK - BAZEL - BITBUCKET - BITNAMI - CARGO - COCOAPODS - COMPOSER - CONAN - CONDA - CPAN - CRAN - DEB - DOCKER - GEM - GENERIC - GITHUB - GO - HACKAGE - HEX - HUGGINGFACE - JULIA - LUAROCKS - MAVEN - MLFLOW - NPM - NUGET - OCI - OPAM - OTP - PUB - PYPI - QPKG - RPM - SWID - SWIFT - VSCODE_EXTENSION - YOCTO required: - asset_class - asset_type - technology_key - purl - package_type responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/software: post: tags: - Assets summary: Create asset software operationId: createAsset_SOFTWARE description: Create a software requestBody: description: Body of the request to create an asset content: application/json: schema: type: object properties: projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. name: type: - string - 'null' description: The custom name of the asset. If not provided, the default name will be used. example: My Asset asset_class: type: string enum: - TECHNOLOGY extra_metadata: type: - object - 'null' additionalProperties: {} screenshot_s3_key: type: - string - 'null' asset_type: type: string enum: - SOFTWARE technology_key: type: string version: type: - string - 'null' reference_url: type: - string - 'null' cpe: type: - string - 'null' cpe_guessed: type: - boolean - 'null' well_known_technology: type: - string - 'null' enum: - REDIS - NGINX - APACHE - REACT - ANGULAR - VUE - SVELTE - null description: type: - string - 'null' required: - asset_class - asset_type - technology_key responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /assets/schema: post: tags: - Assets summary: Create asset schema operationId: createAsset_schema description: "Create a schema asset.\n\nThe schema data can either be fetched from a URL or uploaded from a file.\n\n**Fetch example:**\n```json\n{\n \"asset_type\": \"SCHEMA\",\n \"fetch\": {\n \"url\": \"https://api.example.com/v1\"\n }\n}\n```\n\n\n**Upload example:**\n\nThe file should first be uploaded to the Escape Platform using the [upload endpoint](/v3/#tag/upload/post/upload/signed-url).\n\nThe upload endpoint returns an `id` that should be used in the `temporaryObjectKey` field.\n\n```json\n{\n \"asset_type\": \"SCHEMA\",\n \"upload\": {\n \"temporaryObjectKey\": \"00000000-0000-0000-0000-000000000000\"\n }\n}\n```\n" requestBody: description: Body of the request to create a schema asset content: application/json: schema: anyOf: - type: object properties: asset_type: type: string enum: - SCHEMA name: type: - string - 'null' example: My Schema projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. fetch: type: object properties: url: type: string example: https://api.example.com/v1 proxyId: type: string example: 00000000-0000-0000-0000-000000000000 required: - url authentication: type: object properties: $schema: type: string lifetime: type: - number - 'null' procedures: type: array items: type: object properties: name: type: string operations: type: array items: oneOf: - type: object properties: tech: type: string enum: - http parameters: type: object properties: proxy_override: type: - string - 'null' url: type: string method: type: string enum: - CONNECT - DELETE - GET - HEAD - OPTIONS - PATCH - POST - PUT - TRACE headers: type: array items: type: object properties: name: type: string values: type: array items: type: string required: - name - values cookies: type: array items: type: object properties: name: type: string domain: type: - string - 'null' path: type: - string - 'null' http_only: type: - boolean - 'null' secure: type: - boolean - 'null' same_site: type: - string - 'null' enum: - Strict - Lax - None - null values: type: array items: type: string required: - name - values queryParameters: type: array items: type: object properties: name: type: string values: type: array items: type: string required: - name - values body: {} timeout: type: number insecure: type: boolean follow_redirects: type: number required: - url - method - headers - cookies - queryParameters extractions: type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string regex: type: string name: type: string required: - location - key - name required: - tech - parameters - extractions - type: object properties: tech: type: string enum: - oauth_authz_code_browser parameters: type: object properties: proxy_override: type: - string - 'null' login_url: type: string auto_extraction_urls: type: - array - 'null' items: type: string logged_in_detector_text: type: - string - 'null' logged_in_detector_timeout: type: - number - 'null' stealth_mode: type: - boolean - 'null' logout_detection: type: - object - 'null' properties: enabled: type: - boolean - 'null' instructions: type: - string - 'null' authorization_url: type: string token_url: type: string redirect_uri: type: string client_id: type: string client_secret: type: string use_pkce: type: boolean login_timeout: type: number required: - login_url - authorization_url - token_url - redirect_uri - client_id - client_secret - use_pkce - login_timeout extractions: anyOf: - type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string regex: type: string name: type: string required: - location - key - name - type: array items: type: object properties: location: type: string enum: - page - browser_local_storage - browser_session_storage - browser_cookies origin: type: string key: type: string name: type: string regex: type: - string - 'null' jq: type: - string - 'null' required: - location - origin - key - name required: - tech - parameters - extractions - type: object properties: tech: type: string enum: - browser_agent parameters: type: object properties: proxy_override: type: - string - 'null' login_url: type: string auto_extraction_urls: type: - array - 'null' items: type: string logged_in_detector_text: type: - string - 'null' logged_in_detector_timeout: type: - number - 'null' stealth_mode: type: - boolean - 'null' logout_detection: type: - object - 'null' properties: enabled: type: - boolean - 'null' instructions: type: - string - 'null' agentic: type: - object - 'null' properties: enabled: type: boolean instructions: type: - string - 'null' required: - enabled required: - login_url extractions: anyOf: - type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string regex: type: string name: type: string required: - location - key - name - type: array items: type: object properties: location: type: string enum: - page - browser_local_storage - browser_session_storage - browser_cookies origin: type: string key: type: string name: type: string regex: type: - string - 'null' jq: type: - string - 'null' required: - location - origin - key - name required: - tech - parameters - extractions - type: object properties: tech: type: string enum: - browser_actions parameters: type: object properties: proxy_override: type: - string - 'null' login_url: type: string auto_extraction_urls: type: - array - 'null' items: type: string logged_in_detector_text: type: - string - 'null' logged_in_detector_timeout: type: - number - 'null' stealth_mode: type: - boolean - 'null' logout_detection: type: - object - 'null' properties: enabled: type: - boolean - 'null' instructions: type: - string - 'null' required: - login_url extractions: anyOf: - type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string regex: type: string name: type: string required: - location - key - name - type: array items: type: object properties: location: type: string enum: - page - browser_local_storage - browser_session_storage - browser_cookies origin: type: string key: type: string name: type: string regex: type: - string - 'null' jq: type: - string - 'null' required: - location - origin - key - name required: - tech - parameters - extractions - type: object properties: tech: type: string enum: - custom_bpce parameters: type: object properties: proxy_override: type: - string - 'null' environment: type: string enum: - BP - CE required: - environment extractions: anyOf: - type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string regex: type: string name: type: string required: - location - key - name - type: array items: type: object properties: location: type: string enum: - page - browser_local_storage - browser_session_storage - browser_cookies origin: type: string key: type: string name: type: string regex: type: - string - 'null' jq: type: - string - 'null' required: - location - origin - key - name required: - tech - parameters - extractions - type: object properties: tech: type: string enum: - custom_msc parameters: type: object properties: proxy_override: type: - string - 'null' tenant_id: type: string client_id: type: string resource_app_id: type: string certificate_pfx_base64: type: string certificate_password: type: - string - 'null' scope: type: - string - 'null' token_url: type: - string - 'null' required: - tenant_id - client_id - resource_app_id - certificate_pfx_base64 extractions: anyOf: - type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string regex: type: string name: type: string required: - location - key - name - type: array items: type: object properties: location: type: string enum: - page - browser_local_storage - browser_session_storage - browser_cookies origin: type: string key: type: string name: type: string regex: type: - string - 'null' jq: type: - string - 'null' required: - location - origin - key - name required: - tech - parameters - extractions injections: anyOf: - type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string prefix: type: string variable: type: string required: - location - key - variable - type: array items: type: object properties: location: type: string enum: - page - browser_local_storage - browser_session_storage - browser_cookies origin: type: string key: type: string variable: type: string required: - location - origin - key - variable required: - name - operations - injections users: type: array items: type: object properties: name: type: string role: type: - string - 'null' credentials: type: object properties: username: type: string password: type: string headers: type: - array - 'null' items: type: object properties: name: type: string values: type: array items: type: string required: - name - values cookies: type: - array - 'null' items: type: object properties: name: type: string domain: type: - string - 'null' path: type: - string - 'null' http_only: type: - boolean - 'null' secure: type: - boolean - 'null' same_site: type: - string - 'null' enum: - Strict - Lax - None - null values: type: array items: type: string required: - name - values query_parameters: type: - array - 'null' items: type: object properties: name: type: string values: type: array items: type: string required: - name - values body: {} local_storage: type: - object - 'null' additionalProperties: type: object additionalProperties: type: string session_storage: type: - object - 'null' additionalProperties: type: object additionalProperties: type: string actions: type: - array - 'null' items: oneOf: - type: object properties: action: type: string enum: - click allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - fill allow_failure: type: - boolean - 'null' locator: type: string one_by_one: type: - boolean - 'null' value: type: string auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - fill_totp allow_failure: type: - boolean - 'null' locator: type: string secret: type: string auto_submit: type: - boolean - 'null' required: - action - locator - secret - type: object properties: action: type: string enum: - goto allow_failure: type: - boolean - 'null' new_page: type: - boolean - 'null' url: type: string timeout: type: - number - 'null' required: - action - url - type: object properties: action: type: string enum: - check allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - select allow_failure: type: - boolean - 'null' locator: type: string value: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - wait_element allow_failure: type: - boolean - 'null' locator: type: string timeout: type: number required: - action - locator - timeout - type: object properties: action: type: string enum: - wait_text allow_failure: type: - boolean - 'null' value: type: string timeout: type: number required: - action - value - timeout - type: object properties: action: type: string enum: - focus_page allow_failure: type: - boolean - 'null' url_pattern: type: string required: - action - url_pattern - type: object properties: action: type: string enum: - sleep allow_failure: type: - boolean - 'null' seconds: type: number required: - action - seconds - type: object properties: action: type: string enum: - fill_mail_totp - fill_email_totp allow_failure: type: - boolean - 'null' email_address: type: string locator: type: string one_by_one: type: - boolean - 'null' auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - email_address - locator - type: object properties: action: type: string enum: - click_mail_magic_link allow_failure: type: - boolean - 'null' email_address: type: string new_page: type: - boolean - 'null' timeout: type: - number - 'null' required: - action - email_address - type: object properties: action: type: string enum: - solve_captcha allow_failure: type: - boolean - 'null' locator: type: string auto_submit: type: - boolean - 'null' required: - action - locator pre_login_actions: type: - array - 'null' items: oneOf: - type: object properties: action: type: string enum: - click allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - fill allow_failure: type: - boolean - 'null' locator: type: string one_by_one: type: - boolean - 'null' value: type: string auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - fill_totp allow_failure: type: - boolean - 'null' locator: type: string secret: type: string auto_submit: type: - boolean - 'null' required: - action - locator - secret - type: object properties: action: type: string enum: - goto allow_failure: type: - boolean - 'null' new_page: type: - boolean - 'null' url: type: string timeout: type: - number - 'null' required: - action - url - type: object properties: action: type: string enum: - check allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - select allow_failure: type: - boolean - 'null' locator: type: string value: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - wait_element allow_failure: type: - boolean - 'null' locator: type: string timeout: type: number required: - action - locator - timeout - type: object properties: action: type: string enum: - wait_text allow_failure: type: - boolean - 'null' value: type: string timeout: type: number required: - action - value - timeout - type: object properties: action: type: string enum: - focus_page allow_failure: type: - boolean - 'null' url_pattern: type: string required: - action - url_pattern - type: object properties: action: type: string enum: - sleep allow_failure: type: - boolean - 'null' seconds: type: number required: - action - seconds - type: object properties: action: type: string enum: - fill_mail_totp - fill_email_totp allow_failure: type: - boolean - 'null' email_address: type: string locator: type: string one_by_one: type: - boolean - 'null' auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - email_address - locator - type: object properties: action: type: string enum: - click_mail_magic_link allow_failure: type: - boolean - 'null' email_address: type: string new_page: type: - boolean - 'null' timeout: type: - number - 'null' required: - action - email_address - type: object properties: action: type: string enum: - solve_captcha allow_failure: type: - boolean - 'null' locator: type: string auto_submit: type: - boolean - 'null' required: - action - locator post_login_actions: type: - array - 'null' items: oneOf: - type: object properties: action: type: string enum: - click allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - fill allow_failure: type: - boolean - 'null' locator: type: string one_by_one: type: - boolean - 'null' value: type: string auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - fill_totp allow_failure: type: - boolean - 'null' locator: type: string secret: type: string auto_submit: type: - boolean - 'null' required: - action - locator - secret - type: object properties: action: type: string enum: - goto allow_failure: type: - boolean - 'null' new_page: type: - boolean - 'null' url: type: string timeout: type: - number - 'null' required: - action - url - type: object properties: action: type: string enum: - check allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - select allow_failure: type: - boolean - 'null' locator: type: string value: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - wait_element allow_failure: type: - boolean - 'null' locator: type: string timeout: type: number required: - action - locator - timeout - type: object properties: action: type: string enum: - wait_text allow_failure: type: - boolean - 'null' value: type: string timeout: type: number required: - action - value - timeout - type: object properties: action: type: string enum: - focus_page allow_failure: type: - boolean - 'null' url_pattern: type: string required: - action - url_pattern - type: object properties: action: type: string enum: - sleep allow_failure: type: - boolean - 'null' seconds: type: number required: - action - seconds - type: object properties: action: type: string enum: - fill_mail_totp - fill_email_totp allow_failure: type: - boolean - 'null' email_address: type: string locator: type: string one_by_one: type: - boolean - 'null' auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - email_address - locator - type: object properties: action: type: string enum: - click_mail_magic_link allow_failure: type: - boolean - 'null' email_address: type: string new_page: type: - boolean - 'null' timeout: type: - number - 'null' required: - action - email_address - type: object properties: action: type: string enum: - solve_captcha allow_failure: type: - boolean - 'null' locator: type: string auto_submit: type: - boolean - 'null' required: - action - locator digest: type: - string - 'null' basic: type: - string - 'null' procedure: type: string variables: type: - array - 'null' items: type: object properties: name: type: string value: type: string required: - name - value main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' user_instructions: type: - string - 'null' required: - name validation: type: boolean proxy: type: string presets: type: array items: oneOf: - type: object properties: type: type: string enum: - http users: type: array items: type: object properties: username: type: string headers: type: - object - 'null' additionalProperties: type: string cookies: type: - object - 'null' additionalProperties: type: string queryParameters: type: - object - 'null' additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' password: type: string body: {} required: - username request: type: object properties: url: type: string method: type: string enum: - CONNECT - DELETE - GET - HEAD - OPTIONS - PATCH - POST - PUT - TRACE headers: type: - object - 'null' additionalProperties: type: string cookies: type: - object - 'null' additionalProperties: type: string query_parameters: type: - object - 'null' additionalProperties: type: string body: {} required: - url - method extractions: type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string regex: type: string name: type: string required: - location - key - name injections: type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string prefix: type: string variable: type: string required: - location - key - variable required: - type - users - request - type: object properties: type: type: string enum: - oauth_ropc users: type: array items: type: object properties: username: type: string headers: type: object additionalProperties: type: string cookies: type: object additionalProperties: type: string query_parameters: type: object additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' password: type: string scopes: type: array items: type: string required: - username - password url: type: string client_id: type: string client_secret: type: string required: - type - users - url - client_id - client_secret - type: object properties: type: type: string enum: - oauth_client_credentials users: type: array items: type: object properties: username: type: string headers: type: object additionalProperties: type: string cookies: type: object additionalProperties: type: string query_parameters: type: object additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' client_id: type: string client_secret: type: string scopes: type: array items: type: string audience: type: string basic_style: type: - boolean - 'null' required: - username - client_id - client_secret url: type: string required: - type - users - url - type: object properties: type: type: string enum: - oauth_authz_code_browser users: type: array items: type: object properties: username: type: string headers: type: object additionalProperties: type: string cookies: type: object additionalProperties: type: string query_parameters: type: object additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' password: type: string scopes: type: array items: type: string pre_login_actions: type: - array - 'null' items: oneOf: - type: object properties: action: type: string enum: - click allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - fill allow_failure: type: - boolean - 'null' locator: type: string one_by_one: type: - boolean - 'null' value: type: string auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - fill_totp allow_failure: type: - boolean - 'null' locator: type: string secret: type: string auto_submit: type: - boolean - 'null' required: - action - locator - secret - type: object properties: action: type: string enum: - goto allow_failure: type: - boolean - 'null' new_page: type: - boolean - 'null' url: type: string timeout: type: - number - 'null' required: - action - url - type: object properties: action: type: string enum: - check allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - select allow_failure: type: - boolean - 'null' locator: type: string value: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - wait_element allow_failure: type: - boolean - 'null' locator: type: string timeout: type: number required: - action - locator - timeout - type: object properties: action: type: string enum: - wait_text allow_failure: type: - boolean - 'null' value: type: string timeout: type: number required: - action - value - timeout - type: object properties: action: type: string enum: - focus_page allow_failure: type: - boolean - 'null' url_pattern: type: string required: - action - url_pattern - type: object properties: action: type: string enum: - sleep allow_failure: type: - boolean - 'null' seconds: type: number required: - action - seconds - type: object properties: action: type: string enum: - fill_mail_totp - fill_email_totp allow_failure: type: - boolean - 'null' email_address: type: string locator: type: string one_by_one: type: - boolean - 'null' auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - email_address - locator - type: object properties: action: type: string enum: - click_mail_magic_link allow_failure: type: - boolean - 'null' email_address: type: string new_page: type: - boolean - 'null' timeout: type: - number - 'null' required: - action - email_address - type: object properties: action: type: string enum: - solve_captcha allow_failure: type: - boolean - 'null' locator: type: string auto_submit: type: - boolean - 'null' required: - action - locator post_login_actions: type: - array - 'null' items: oneOf: - type: object properties: action: type: string enum: - click allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - fill allow_failure: type: - boolean - 'null' locator: type: string one_by_one: type: - boolean - 'null' value: type: string auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - fill_totp allow_failure: type: - boolean - 'null' locator: type: string secret: type: string auto_submit: type: - boolean - 'null' required: - action - locator - secret - type: object properties: action: type: string enum: - goto allow_failure: type: - boolean - 'null' new_page: type: - boolean - 'null' url: type: string timeout: type: - number - 'null' required: - action - url - type: object properties: action: type: string enum: - check allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - select allow_failure: type: - boolean - 'null' locator: type: string value: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - wait_element allow_failure: type: - boolean - 'null' locator: type: string timeout: type: number required: - action - locator - timeout - type: object properties: action: type: string enum: - wait_text allow_failure: type: - boolean - 'null' value: type: string timeout: type: number required: - action - value - timeout - type: object properties: action: type: string enum: - focus_page allow_failure: type: - boolean - 'null' url_pattern: type: string required: - action - url_pattern - type: object properties: action: type: string enum: - sleep allow_failure: type: - boolean - 'null' seconds: type: number required: - action - seconds - type: object properties: action: type: string enum: - fill_mail_totp - fill_email_totp allow_failure: type: - boolean - 'null' email_address: type: string locator: type: string one_by_one: type: - boolean - 'null' auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - email_address - locator - type: object properties: action: type: string enum: - click_mail_magic_link allow_failure: type: - boolean - 'null' email_address: type: string new_page: type: - boolean - 'null' timeout: type: - number - 'null' required: - action - email_address - type: object properties: action: type: string enum: - solve_captcha allow_failure: type: - boolean - 'null' locator: type: string auto_submit: type: - boolean - 'null' required: - action - locator required: - username - password authorization_url: type: string token_url: type: string client_id: type: string client_secret: type: string redirect_uri: type: string scopes: type: array items: type: string use_pkce: type: boolean login_timeout: type: - number - 'null' logout_detection: type: - object - 'null' properties: enabled: type: - boolean - 'null' instructions: type: - string - 'null' required: - type - users - authorization_url - token_url - client_id - client_secret - redirect_uri - use_pkce - type: object properties: type: type: string enum: - basic users: type: array items: type: object properties: username: type: string headers: type: object additionalProperties: type: string cookies: type: object additionalProperties: type: string query_parameters: type: object additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' password: type: string required: - username - password required: - type - users - type: object properties: type: type: string enum: - graphql users: type: array items: type: object properties: username: type: string headers: type: object additionalProperties: type: string cookies: type: object additionalProperties: type: string query_parameters: type: object additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' variables: type: object additionalProperties: type: string required: - username - variables url: type: string query: type: string extractions: type: - array - 'null' items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string regex: type: string name: type: string required: - location - key - name injections: type: - array - 'null' items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string prefix: type: string variable: type: string required: - location - key - variable required: - type - users - url - query - type: object properties: type: type: string enum: - digest users: type: array items: type: object properties: username: type: string headers: type: object additionalProperties: type: string cookies: type: object additionalProperties: type: string query_parameters: type: object additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' password: type: string required: - username - password required: - type - users - type: object properties: type: type: string enum: - cognito_userpass users: type: array items: type: object properties: username: type: string headers: type: object additionalProperties: type: string cookies: type: object additionalProperties: type: string query_parameters: type: object additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' password: type: string scopes: type: array items: type: string required: - username - password region: type: string enum: - us-east-2 - us-east-1 - us-west-1 - us-west-2 - af-south-1 - ap-east-1 - ap-south-1 - ap-northeast-3 - ap-northeast-2 - ap-southeast-1 - ap-southeast-2 - ap-northeast-1 - ca-central-1 - cn-north-1 - cn-northwest-1 - eu-central-1 - eu-west-1 - eu-west-2 - eu-south-1 - eu-west-3 - eu-north-1 - me-south-1 - sa-east-1 client_id: type: string client_secret: type: string required: - type - users - region - client_id - client_secret - type: object properties: type: type: string enum: - headers users: type: array items: type: object properties: username: type: string headers: type: object additionalProperties: type: string cookies: type: object additionalProperties: type: string query_parameters: type: object additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' required: - username - headers required: - type - users - type: object properties: type: type: string enum: - curl users: type: array items: type: object properties: username: type: string headers: type: object additionalProperties: type: string cookies: type: object additionalProperties: type: string query_parameters: type: object additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' curl: type: string required: - username - curl extractions: type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string regex: type: string name: type: string required: - location - key - name injections: type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string prefix: type: string variable: type: string required: - location - key - variable required: - type - users - extractions - injections - type: object properties: type: type: string enum: - curl_sequence users: type: array items: type: object properties: username: type: string headers: type: object additionalProperties: type: string cookies: type: object additionalProperties: type: string query_parameters: type: object additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' variables: type: object additionalProperties: type: string required: - username requests: type: array items: type: object properties: curl: type: string extractions: type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string regex: type: string name: type: string required: - location - key - name required: - curl injections: type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string prefix: type: string variable: type: string required: - location - key - variable required: - type - users - requests - type: object properties: type: type: string enum: - browser_agent users: type: array items: type: object properties: username: type: string headers: type: object additionalProperties: type: string cookies: type: object additionalProperties: type: string query_parameters: type: object additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' password: type: string additional_fields: type: - array - 'null' items: type: object properties: locator: type: string value: type: string one_by_one: type: - boolean - 'null' auto_submit: type: - boolean - 'null' required: - locator - value pre_login_actions: type: - array - 'null' items: oneOf: - type: object properties: action: type: string enum: - click allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - fill allow_failure: type: - boolean - 'null' locator: type: string one_by_one: type: - boolean - 'null' value: type: string auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - fill_totp allow_failure: type: - boolean - 'null' locator: type: string secret: type: string auto_submit: type: - boolean - 'null' required: - action - locator - secret - type: object properties: action: type: string enum: - goto allow_failure: type: - boolean - 'null' new_page: type: - boolean - 'null' url: type: string timeout: type: - number - 'null' required: - action - url - type: object properties: action: type: string enum: - check allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - select allow_failure: type: - boolean - 'null' locator: type: string value: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - wait_element allow_failure: type: - boolean - 'null' locator: type: string timeout: type: number required: - action - locator - timeout - type: object properties: action: type: string enum: - wait_text allow_failure: type: - boolean - 'null' value: type: string timeout: type: number required: - action - value - timeout - type: object properties: action: type: string enum: - focus_page allow_failure: type: - boolean - 'null' url_pattern: type: string required: - action - url_pattern - type: object properties: action: type: string enum: - sleep allow_failure: type: - boolean - 'null' seconds: type: number required: - action - seconds - type: object properties: action: type: string enum: - fill_mail_totp - fill_email_totp allow_failure: type: - boolean - 'null' email_address: type: string locator: type: string one_by_one: type: - boolean - 'null' auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - email_address - locator - type: object properties: action: type: string enum: - click_mail_magic_link allow_failure: type: - boolean - 'null' email_address: type: string new_page: type: - boolean - 'null' timeout: type: - number - 'null' required: - action - email_address - type: object properties: action: type: string enum: - solve_captcha allow_failure: type: - boolean - 'null' locator: type: string auto_submit: type: - boolean - 'null' required: - action - locator post_login_actions: type: - array - 'null' items: oneOf: - type: object properties: action: type: string enum: - click allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - fill allow_failure: type: - boolean - 'null' locator: type: string one_by_one: type: - boolean - 'null' value: type: string auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - fill_totp allow_failure: type: - boolean - 'null' locator: type: string secret: type: string auto_submit: type: - boolean - 'null' required: - action - locator - secret - type: object properties: action: type: string enum: - goto allow_failure: type: - boolean - 'null' new_page: type: - boolean - 'null' url: type: string timeout: type: - number - 'null' required: - action - url - type: object properties: action: type: string enum: - check allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - select allow_failure: type: - boolean - 'null' locator: type: string value: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - wait_element allow_failure: type: - boolean - 'null' locator: type: string timeout: type: number required: - action - locator - timeout - type: object properties: action: type: string enum: - wait_text allow_failure: type: - boolean - 'null' value: type: string timeout: type: number required: - action - value - timeout - type: object properties: action: type: string enum: - focus_page allow_failure: type: - boolean - 'null' url_pattern: type: string required: - action - url_pattern - type: object properties: action: type: string enum: - sleep allow_failure: type: - boolean - 'null' seconds: type: number required: - action - seconds - type: object properties: action: type: string enum: - fill_mail_totp - fill_email_totp allow_failure: type: - boolean - 'null' email_address: type: string locator: type: string one_by_one: type: - boolean - 'null' auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - email_address - locator - type: object properties: action: type: string enum: - click_mail_magic_link allow_failure: type: - boolean - 'null' email_address: type: string new_page: type: - boolean - 'null' timeout: type: - number - 'null' required: - action - email_address - type: object properties: action: type: string enum: - solve_captcha allow_failure: type: - boolean - 'null' locator: type: string auto_submit: type: - boolean - 'null' required: - action - locator instructions: type: - string - 'null' required: - username - password login_url: type: string stealth_mode: type: - boolean - 'null' logout_detection: type: - object - 'null' properties: enabled: type: - boolean - 'null' instructions: type: - string - 'null' extractions: type: - array - 'null' items: type: object properties: location: type: string enum: - page - browser_local_storage - browser_session_storage - browser_cookies origin: type: string key: type: string name: type: string regex: type: - string - 'null' jq: type: - string - 'null' required: - location - origin - key - name injections: anyOf: - type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string prefix: type: string variable: type: string required: - location - key - variable - type: array items: type: object properties: location: type: string enum: - page - browser_local_storage - browser_session_storage - browser_cookies origin: type: string key: type: string variable: type: string required: - location - origin - key - variable - type: 'null' auto_extraction_urls: type: - array - 'null' items: type: string logged_in_detector_text: type: - string - 'null' logged_in_detector_timeout: type: - number - 'null' agentic: type: - object - 'null' properties: enabled: type: boolean instructions: type: - string - 'null' required: - enabled required: - type - users - login_url - type: object properties: type: type: string enum: - browser_actions users: type: array items: type: object properties: username: type: string headers: type: object additionalProperties: type: string cookies: type: object additionalProperties: type: string query_parameters: type: object additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' actions: type: array items: oneOf: - type: object properties: action: type: string enum: - click allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - fill allow_failure: type: - boolean - 'null' locator: type: string one_by_one: type: - boolean - 'null' value: type: string auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - fill_totp allow_failure: type: - boolean - 'null' locator: type: string secret: type: string auto_submit: type: - boolean - 'null' required: - action - locator - secret - type: object properties: action: type: string enum: - goto allow_failure: type: - boolean - 'null' new_page: type: - boolean - 'null' url: type: string timeout: type: - number - 'null' required: - action - url - type: object properties: action: type: string enum: - check allow_failure: type: - boolean - 'null' locator: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - type: object properties: action: type: string enum: - select allow_failure: type: - boolean - 'null' locator: type: string value: type: string timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - locator - value - type: object properties: action: type: string enum: - wait_element allow_failure: type: - boolean - 'null' locator: type: string timeout: type: number required: - action - locator - timeout - type: object properties: action: type: string enum: - wait_text allow_failure: type: - boolean - 'null' value: type: string timeout: type: number required: - action - value - timeout - type: object properties: action: type: string enum: - focus_page allow_failure: type: - boolean - 'null' url_pattern: type: string required: - action - url_pattern - type: object properties: action: type: string enum: - sleep allow_failure: type: - boolean - 'null' seconds: type: number required: - action - seconds - type: object properties: action: type: string enum: - fill_mail_totp - fill_email_totp allow_failure: type: - boolean - 'null' email_address: type: string locator: type: string one_by_one: type: - boolean - 'null' auto_submit: type: - boolean - 'null' timeout: type: - number - 'null' select_first_if_multiple: type: - boolean - 'null' required: - action - email_address - locator - type: object properties: action: type: string enum: - click_mail_magic_link allow_failure: type: - boolean - 'null' email_address: type: string new_page: type: - boolean - 'null' timeout: type: - number - 'null' required: - action - email_address - type: object properties: action: type: string enum: - solve_captcha allow_failure: type: - boolean - 'null' locator: type: string auto_submit: type: - boolean - 'null' required: - action - locator required: - username - actions login_url: type: string stealth_mode: type: - boolean - 'null' logout_detection: type: - object - 'null' properties: enabled: type: - boolean - 'null' instructions: type: - string - 'null' extractions: type: - array - 'null' items: type: object properties: location: type: string enum: - page - browser_local_storage - browser_session_storage - browser_cookies origin: type: string key: type: string name: type: string regex: type: - string - 'null' jq: type: - string - 'null' required: - location - origin - key - name injections: anyOf: - type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string prefix: type: string variable: type: string required: - location - key - variable - type: array items: type: object properties: location: type: string enum: - page - browser_local_storage - browser_session_storage - browser_cookies origin: type: string key: type: string variable: type: string required: - location - origin - key - variable - type: 'null' auto_extraction_urls: type: - array - 'null' items: type: string logged_in_detector_text: type: - string - 'null' logged_in_detector_timeout: type: - number - 'null' required: - type - users - login_url - type: object properties: type: type: string enum: - custom_bpce users: type: array items: type: object properties: username: type: string headers: type: object additionalProperties: type: string cookies: type: object additionalProperties: type: string query_parameters: type: object additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' password: type: string otp: type: string required: - username - password - otp environment: type: string enum: - BP - CE extractions: type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string regex: type: string name: type: string required: - location - key - name injections: type: array items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string prefix: type: string variable: type: string required: - location - key - variable required: - type - users - environment - type: object properties: type: type: string enum: - custom_msc users: type: array items: type: object properties: username: type: string headers: type: object additionalProperties: type: string cookies: type: object additionalProperties: type: string query_parameters: type: object additionalProperties: type: string main_user: type: - boolean - 'null' allow_failure: type: - boolean - 'null' basic: type: - string - 'null' digest: type: - string - 'null' role: type: - string - 'null' required: - username tenant_id: type: string client_id: type: string resource_app_id: type: string certificate_pfx_base64: type: string certificate_password: type: - string - 'null' scope: type: - string - 'null' token_url: type: - string - 'null' extractions: type: - array - 'null' items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string regex: type: string name: type: string required: - location - key - name injections: type: - array - 'null' items: type: object properties: location: type: string enum: - header - cookie - body - query key: type: string prefix: type: string variable: type: string required: - location - key - variable required: - type - users - tenant_id - client_id - resource_app_id - certificate_pfx_base64 multi_user_is_fallback: type: - boolean - 'null' description: The authentication object of the asset examples: - users: - name: public - presets: - type: headers users: - username: test-user headers: Authorization: Basic dXNlcjpwYXNz authenticationStr: type: string description: Deprecated. Use `authentication` object instead. JSON-encoded authentication object. deprecated: true examples: - '{"users":[{"name":"public"}]}' - '{"presets":[{"type":"headers","users":[{"username":"test-user","headers":{"Authorization":"Basic dXNlcjpwYXNz"}}]}]}' required: - asset_type - fetch title: Create schema via fetch - type: object properties: asset_type: type: string enum: - SCHEMA name: type: - string - 'null' example: My Schema projectIds: type: - array - 'null' items: type: string format: uuid description: The list of project IDs bind the asset on. upload: type: object properties: temporaryObjectKey: type: string example: 00000000-0000-0000-0000-000000000000 required: - temporaryObjectKey required: - asset_type - upload title: Create schema via upload title: Create asset schema request responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the asset class: type: string enum: - API_SERVICE - CDN - CLOUD_COMPONENT - CLOUD_HOSTING - CODE_PROJECT - CSPM - DEV_TOOLS - FRONTEND - HOST - NETWORK - REPOSITORY - SCHEMA - SOURCE_CODE_MANAGEMENT - TECHNOLOGY type: type: string enum: - AKAMAI_ACCOUNT - AWS_ACCOUNT - AWS_LAMBDA - AZURE_TENANT - BITBUCKET_ORGANIZATION - BITBUCKET_REPOSITORY - BURPSUITE_EXPORT - CLOUDFLARE_ACCOUNT - CODE_PROJECT - DNS - GCP_PROJECT - GITHUB_ORGANIZATION - GITHUB_REPOSITORY - GITLAB_GROUP - GITLAB_REPOSITORY - GRAPHQL - GRAPHQL_SCHEMA - GRPC - HAR_EXPORT - INSOMNIA - IPV4 - IPV4_RANGE - IPV6 - KUBERNETES_CLUSTER - MCP - OPENAPI - PACKAGE - POSTMAN_COLLECTION - POSTMAN_ENVIRONMENT - POSTMAN_ORGANIZATION - REST - SOAP - SOFTWARE - WEBAPP - WEBSOCKET - WIZ_ACCOUNT - WP_JSON name: type: string description: The name of the asset externalUrl: type: - string - 'null' description: The external url of the asset faviconUrl: type: - string - 'null' description: The favicon url of the asset description: type: - string - 'null' description: The description of the asset createdAt: type: string description: The date and time the asset was created lastSeenAt: type: string description: The date and time the asset was last seen scheduledForDeletionAt: type: - string - 'null' description: The date and time the asset is scheduled for deletion status: type: string enum: - DEPRECATED - FALSE_POSITIVE - MONITORED - OUT_OF_SCOPE - THIRD_PARTY description: The status of the asset owners: type: array items: type: string description: The owners of the asset tags: type: array items: type: object properties: id: type: string format: uuid description: The id of the tag name: type: string description: The name of the tag color: type: string description: The color of the tag required: - id - name - color title: Tag description: Information about a tag description: The tags of the asset risks: type: array items: type: string enum: - CRITICAL_FINDING - EXPOSED - OPEN_SCHEMA - PRIVATE - PROD_ONLY_MODE - SENSITIVE_DATA - UNAUTHENTICATED description: The risks of the asset firstSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The first seen scan of the asset lastSeenScan: type: - object - 'null' properties: id: type: string format: uuid description: The id of the scan status: type: string description: The status of the scan createdAt: type: string description: The date and time the scan was created finishedAt: type: - string - 'null' description: The date and time the scan was finished score: type: - number - 'null' description: The score of the scan coverage: type: - number - 'null' description: Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data duration: type: number description: The duration of the scan progressRatio: type: number description: The progress ratio of the scan initiator: type: string description: The initiator of the scan kind: type: string description: The kind of the scan commitHash: type: - string - 'null' description: The commit hash of the scan commitBranch: type: - string - 'null' description: The commit branch of the scan links: type: object properties: scanIssues: type: string description: The url to view the scan issues in the platform required: - scanIssues description: The links of the scan required: - id - status - createdAt - finishedAt - score - coverage - duration - progressRatio - initiator - kind - commitHash - commitBranch - links title: ScanSummarized description: The last seen scan of the asset service: type: - object - 'null' properties: type: type: string enum: - GRAPHQL - GRPC - MCP - REST - SOAP - WEBSOCKET url: type: string framework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null tls: type: boolean ips: type: array items: type: string required: - type - url - framework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - tls - ips title: AssetServiceDetailed description: The service of the asset frontend: type: - object - 'null' properties: type: type: string enum: - WEBAPP url: type: string framework: type: - string - 'null' APIFramework: type: - string - 'null' authProtocol: type: - string - 'null' authTechnology: type: - string - 'null' enum: - AUTH0 - AWS_IAM - AZURE_ACTIVE_DIRECTORY - COGNITO - KEYCLOAK - UNKNOWN - null cloudProvider: type: - string - 'null' enum: - AKAMAI - ALIBABA - AWS - AZURE - CLOUDFLARE - DIGITALOCEAN - FASTLY - GCP - GRAVITEE - HEROKU - IBM - LINODE - ORACLE - OVH - SCALEWAY - TENCENT - UCLOUD - UNKNOWN - VERCEL - null wafProvider: type: - string - 'null' enum: - ACE_XML_GATEWAY - AESECURE - AIREECDN - AIRLOCK - ALERT_LOGIC - ALIYUNDUN - ANQUANBAO - ANYU - APPROACH - APPWALL - ARMOR_DEFENSE - ARVANCLOUD - ASPA_FIREWALL - ASP_NET_GENERIC - ASP_NET_WAF - ASTRA - AWS_ELASTIC_LOAD_BALANCER - AZIONCDN - AZURE_FRONT_DOOR - BARIKODE - BARRACUDA - BEKCHY - BELUGA_CDN - BINARYSEC - BITNINJA - BLOCKDOS - BLUEDON - BULLETPROOF_SECURITY_PRO - CACHEFLY_CDN - CACHEWALL - CDNNS_APPLICATION_GATEWAY - CHINACACHE_LOAD_BALANCER - CHUANG_YU_SHIELD - CLOUDBRIC - CLOUDFLARE - CLOUDFLOOR - CLOUDFRONT - COMODO_CWATCH - CRAWLPROTECT - DATADOME - DATAPOWER - DENYALL - DISTIL - DOSARREST - DOTDEFENDER - DYNAMICWEB_INJECTION_CHECK - EDGECAST - EEYE_SECUREIIS - EISOO_CLOUD_FIREWALL - EXPRESSION_ENGINE - F5_NETWORKS - FASTLY - FIREPASS - FORTIWEB - GODADDY_WEBSITE_PROTECTION - GOOGLE_CLOUD_APP_ARMOR - GREYWIZARD - HUAWEI_CLOUD_FIREWALL - HYPERGUARD - IMUNIFY360 - INCAPSULA - INDUSGUARD - INSTART_DX - ISA_SERVER - JANUSEC_APPLICATION_GATEWAY - JIASULE - KEYCDN - KONA_SITEDEFENDER - KS_WAF - LIMELIGHT_CDN - LITESPEED - MALCARE - MAXCDN - MISSION_CONTROL_SHIELD - MODSECURITY - NAXSI - NEMESIDA - NETCONTINUUM - NETSCALER_APPFIREWALL - NEVISPROXY - NEWDEFEND - NEXUSGUARD_FIREWALL - NINJAFIREWALL - NSFOCUS - NULLDDOS_PROTECTION - ONMESSAGE_SHIELD - OPEN_RESTY_LUA_NGINX - ORACLE_CLOUD - PALO_ALTO_NEXT_GEN_FIREWALL - PENTAWAF - PERIMETERX - PKSECURITY_IDS - POWERCDN - PROFENSE - PT_APPLICATION_FIREWALL - PUHUI - QCLOUD - QINIU - RAYWAF - REBLAZE - RSFIREWALL - SABRE_FIREWALL - SAFE3_WEB_FIREWALL - SAFEDOG - SAFELINE - SECKING - SECUPRESS_WP_SECURITY - SECURESPHERE - SECURE_ENTRY - SENGINX - SERVERDEFENDER_VP - SHADOW_DAEMON - SHIELD_SECURITY - SITEGROUND - SITEGUARD - SITELOCK - SONICWALL - SQUARESPACE - SQUIDPROXY_IDS - STACKPATH - SUCURI_CLOUDPROXY - TENCENT_CLOUD_FIREWALL - TEROS - TRAFFICSHIELD - TRANSIP_WEB_FIREWALL - UEWAF - UNKNOWN - URLMASTER_SECURITYCHECK - URLSCAN - UTM_WEB_PROTECTION - VARNISH - VIETTEL - VIRUSDIE - WALLARM - WATCHGUARD - WEBARX - WEBKNIGHT - WEBLAND - WEBSEAL - WEBTOTEM - WEST263_CDN - WORDFENCE - WPMUDEV_WAF - WP_CERBER_SECURITY - WTS_WAF - XLABS_SECURITY_WAF - XUANWUDUN - YUNDUN - YUNJIASU - YUNSUO - YXLINK - ZENEDGE - ZSCALER - null environment: type: - string - 'null' enum: - DEVELOPMENT - PRODUCTION - STAGING - UNKNOWN - null ips: type: array items: type: string tls: type: boolean required: - type - url - framework - APIFramework - authProtocol - authTechnology - cloudProvider - wafProvider - environment - ips - tls title: AssetFrontendDetailed description: The frontend of the asset host: type: - object - 'null' properties: type: type: string enum: - DNS - IPV4 - IPV6 address: type: string ips: type: array items: type: string ports: type: array items: type: object properties: port: type: number required: - port records: type: array items: type: object properties: type: type: string value: type: string required: - type - value required: - type - address - ips - ports - records title: AssetHostDetailed description: The host of the asset schemaUrl: type: - string - 'null' description: Time-limited HTTPS URL for schema-class assets; null for other asset classes links: type: object properties: assetOverview: type: string description: The url to view the asset overview in the platform required: - assetOverview description: The links of the asset required: - id - class - type - name - externalUrl - faviconUrl - description - createdAt - lastSeenAt - scheduledForDeletionAt - status - tags - risks - firstSeenScan - lastSeenScan - service - frontend - host - schemaUrl - links '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation components: securitySchemes: apiKey: type: apiKey in: header name: X-ESCAPE-API-KEY