Socket deprecated API
The deprecated API from Socket — 17 operation(s) for deprecated.
OpenAPI Specification
openapi: 3.0.0
info:
description: Specification of the Socket API endpoints
title: API Endpoints alerts deprecated API
version: '0'
servers:
- url: https://api.socket.dev/v0
tags:
- name: deprecated
paths:
/dependencies/upload:
post:
tags:
- deprecated
summary: Create a snapshot of all dependencies from manifest information
deprecated: true
operationId: createDependenciesSnapshot
parameters:
- name: repository
in: query
required: false
description: ''
schema:
type: string
default: ''
- name: branch
in: query
required: false
description: ''
schema:
type: string
default: ''
requestBody:
content:
multipart/form-data:
schema:
type: object
additionalProperties:
type: string
default:
type: Buffer
data: []
format: binary
description: ''
properties:
repository:
type: string
description: ''
default: ''
branch:
type: string
description: ''
default: ''
description: ''
required: false
security:
- bearerAuth:
- report:write
- basicAuth:
- report:write
description: '**This endpoint is deprecated.**
Upload a set of manifest or lockfiles to get your dependency tree analyzed by Socket.
You can upload multiple lockfiles in the same request, but each filename must be unique.
The name of the file must be in the supported list.
For example, these are valid filenames: "requirements.txt", "package.json", "folder/package.json", and "deep/nested/folder/package.json".
This endpoint consumes 100 units of your quota.
This endpoint requires the following org token scopes:
- report:write'
responses:
'200':
content:
application/json:
schema:
type: object
additionalProperties: false
description: ''
properties: {}
description: ID of the dependencies snapshot
'400':
$ref: '#/components/responses/SocketBadRequest'
'401':
$ref: '#/components/responses/SocketUnauthorized'
'403':
$ref: '#/components/responses/SocketForbidden'
'404':
$ref: '#/components/responses/SocketNotFoundResponse'
'429':
$ref: '#/components/responses/SocketTooManyRequestsResponse'
'500':
$ref: '#/components/responses/SocketInternalServerError'
x-readme: {}
/orgs/{org_slug}/full-scans/diff:
get:
tags:
- deprecated
summary: Diff Full Scans
deprecated: true
operationId: GetOrgDiffScan
parameters:
- name: org_slug
in: path
required: true
description: The slug of the organization
schema:
type: string
- name: after
in: query
required: true
description: The full scan ID of the base/target of the diff (older)
schema:
type: string
- name: before
in: query
required: true
description: The full scan ID of the head/changed side of the diff (newer)
schema:
type: string
- name: include_license_details
in: query
required: false
description: Include license details in the response. This can increase the response size significantly.
schema:
type: boolean
default: false
- name: omit_unchanged
in: query
required: false
description: Omit unchanged artifacts from the response. When set to true, the unchanged field will be set to null.
schema:
type: boolean
default: false
security:
- bearerAuth:
- full-scans:list
- basicAuth:
- full-scans:list
description: '**This endpoint is deprecated.**
Get the difference between two existing Full Scans. The results are not persisted.
This endpoint consumes 1 unit of your quota.
This endpoint requires the following org token scopes:
- full-scans:list'
responses:
'200':
content:
application/json:
schema:
type: object
additionalProperties: false
description: ''
properties:
before:
type: object
additionalProperties: false
description: ''
properties:
id:
type: string
description: ''
default: ''
created_at:
type: string
description: ''
default: ''
updated_at:
type: string
description: ''
default: ''
organization_id:
type: string
description: ''
default: ''
organization_slug:
type: string
description: ''
default: ''
repository_id:
type: string
description: ''
default: ''
repository_slug:
type: string
description: ''
default: ''
branch:
type: string
description: ''
default: ''
nullable: true
commit_message:
type: string
description: ''
default: ''
nullable: true
commit_hash:
type: string
description: ''
default: ''
nullable: true
pull_request:
type: integer
description: ''
default: 0
nullable: true
committers:
type: array
items:
type: string
description: ''
default: ''
description: ''
html_url:
type: string
description: ''
default: ''
nullable: true
api_url:
type: string
description: ''
default: ''
nullable: true
required:
- api_url
- branch
- commit_hash
- commit_message
- committers
- created_at
- html_url
- id
- organization_id
- organization_slug
- pull_request
- repository_id
- repository_slug
- updated_at
after:
type: object
additionalProperties: false
description: ''
properties:
id:
type: string
description: ''
default: ''
created_at:
type: string
description: ''
default: ''
updated_at:
type: string
description: ''
default: ''
organization_id:
type: string
description: ''
default: ''
organization_slug:
type: string
description: ''
default: ''
repository_id:
type: string
description: ''
default: ''
repository_slug:
type: string
description: ''
default: ''
branch:
type: string
description: ''
default: ''
nullable: true
commit_message:
type: string
description: ''
default: ''
nullable: true
commit_hash:
type: string
description: ''
default: ''
nullable: true
pull_request:
type: integer
description: ''
default: 0
nullable: true
committers:
type: array
items:
type: string
description: ''
default: ''
description: ''
html_url:
type: string
description: ''
default: ''
nullable: true
api_url:
type: string
description: ''
default: ''
nullable: true
required:
- api_url
- branch
- commit_hash
- commit_message
- committers
- created_at
- html_url
- id
- organization_id
- organization_slug
- pull_request
- repository_id
- repository_slug
- updated_at
artifacts:
type: object
additionalProperties: false
description: Artifacts in the diff grouped by how they changed between the before and after scans.
properties:
added:
type: array
items:
$ref: '#/components/schemas/SocketDiffArtifact'
description: Artifacts present in the after scan but not the before scan.
removed:
type: array
items:
$ref: '#/components/schemas/SocketDiffArtifact'
description: Artifacts present in the before scan but not the after scan.
unchanged:
type: array
items:
$ref: '#/components/schemas/SocketDiffArtifact'
description: Artifacts present in both scans with no changes. Null when omitted via the omit_unchanged query parameter.
nullable: true
replaced:
type: array
items:
$ref: '#/components/schemas/SocketDiffArtifact'
description: Artifacts replaced between the scans, e.g. the same package supplied by a different source.
updated:
type: array
items:
$ref: '#/components/schemas/SocketDiffArtifact'
description: Artifacts whose version changed between the scans.
required:
- added
- removed
- replaced
- unchanged
- updated
directDependenciesChanged:
type: boolean
default: false
description: ''
diff_report_url:
type: string
description: ''
default: ''
nullable: true
required:
- after
- artifacts
- before
- diff_report_url
- directDependenciesChanged
description: The difference between the two provided Full Scans.
'400':
$ref: '#/components/responses/SocketBadRequest'
'401':
$ref: '#/components/responses/SocketUnauthorized'
'403':
$ref: '#/components/responses/SocketForbidden'
'404':
$ref: '#/components/responses/SocketNotFoundResponse'
'429':
$ref: '#/components/responses/SocketTooManyRequestsResponse'
x-readme: {}
/orgs/{org_slug}/full-scans/diff/gfm:
get:
tags:
- deprecated
summary: SCM Comment for Scan Diff
deprecated: true
operationId: GetOrgFullScanDiffGfm
parameters:
- name: org_slug
in: path
required: true
description: The slug of the organization
schema:
type: string
- name: after
in: query
required: true
description: The head full scan ID (newer)
schema:
type: string
- name: before
in: query
required: true
description: The base full scan ID (older)
schema:
type: string
- name: github_installation_id
in: query
required: false
description: The ID of the GitHub installation. This will be used to get the GitHub installation settings. If not provided, the default GitHub installation settings will be used.
schema:
type: string
security:
- bearerAuth:
- full-scans:list
- basicAuth:
- full-scans:list
description: '**This endpoint is deprecated.**
Get the dependency overview and dependency alert comments in GitHub flavored markdown between the diff between two existing full scans.
This endpoint consumes 1 unit of your quota.
This endpoint requires the following org token scopes:
- full-scans:list'
responses:
'200':
content:
application/json:
schema:
type: object
additionalProperties: false
description: ''
properties:
before:
type: object
additionalProperties: false
description: ''
properties:
id:
type: string
description: ''
default: ''
created_at:
type: string
description: ''
default: ''
updated_at:
type: string
description: ''
default: ''
organization_id:
type: string
description: ''
default: ''
organization_slug:
type: string
description: ''
default: ''
repository_id:
type: string
description: ''
default: ''
repository_slug:
type: string
description: ''
default: ''
branch:
type: string
description: ''
default: ''
nullable: true
commit_message:
type: string
description: ''
default: ''
nullable: true
commit_hash:
type: string
description: ''
default: ''
nullable: true
pull_request:
type: integer
description: ''
default: 0
nullable: true
committers:
type: array
items:
type: string
description: ''
default: ''
description: ''
html_url:
type: string
description: ''
default: ''
nullable: true
api_url:
type: string
description: ''
default: ''
nullable: true
required:
- api_url
- branch
- commit_hash
- commit_message
- committers
- created_at
- html_url
- id
- organization_id
- organization_slug
- pull_request
- repository_id
- repository_slug
- updated_at
after:
type: object
additionalProperties: false
description: ''
properties:
id:
type: string
description: ''
default: ''
created_at:
type: string
description: ''
default: ''
updated_at:
type: string
description: ''
default: ''
organization_id:
type: string
description: ''
default: ''
organization_slug:
type: string
description: ''
default: ''
repository_id:
type: string
description: ''
default: ''
repository_slug:
type: string
description: ''
default: ''
branch:
type: string
description: ''
default: ''
nullable: true
commit_message:
type: string
description: ''
default: ''
nullable: true
commit_hash:
type: string
description: ''
default: ''
nullable: true
pull_request:
type: integer
description: ''
default: 0
nullable: true
committers:
type: array
items:
type: string
description: ''
default: ''
description: ''
html_url:
type: string
description: ''
default: ''
nullable: true
api_url:
type: string
description: ''
default: ''
nullable: true
required:
- api_url
- branch
- commit_hash
- commit_message
- committers
- created_at
- html_url
- id
- organization_id
- organization_slug
- pull_request
- repository_id
- repository_slug
- updated_at
comments:
type: object
additionalProperties: false
description: ''
properties:
overview:
type: string
description: ''
default: ''
alerts:
type: string
description: ''
default: ''
required:
- alerts
- overview
incomplete:
type: boolean
default: false
description: True when either side of the diff was truncated at the plan's dependency limit. When set, the comments contain a limit-exceeded notice instead of a report rendered from the imbalanced diff.
directDependenciesChanged:
type: boolean
default: false
description: ''
diff_report_url:
type: string
description: ''
default: ''
nullable: true
required:
- after
- before
- comments
- diff_report_url
- directDependenciesChanged
- incomplete
description: Metadata about the full scans and the dependency overview and dependency alert comment. Can be used in a pull request context.
'400':
$ref: '#/components/responses/SocketBadRequest'
'401':
$ref: '#/components/responses/SocketUnauthorized'
'403':
$ref: '#/components/responses/SocketForbidden'
'404':
$ref: '#/components/responses/SocketNotFoundResponse'
'429':
$ref: '#/components/responses/SocketTooManyRequestsResponse'
x-readme: {}
/orgs/{org_slug}/settings/license-policy:
get:
tags:
- deprecated
summary: Get Organization License Policy
deprecated: true
operationId: getOrgLicensePolicy
parameters:
- name: org_slug
in: path
required: true
description: The slug of the organization
schema:
type: string
security:
- bearerAuth:
- license-policy:read
- basicAuth:
- license-policy:read
description: '**This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/viewlicensepolicy) instead.
Retrieve the license policy of an organization.
This endpoint consumes 1 unit of your quota.
This endpoint requires the following org token scopes:
- license-policy:read'
responses:
'200':
content:
application/json:
schema:
type: object
description: ''
default: null
description: Retrieved license policy details
'400':
$ref: '#/components/responses/SocketBadRequest'
'401':
$ref: '#/components/responses/SocketUnauthorized'
'403':
$ref: '#/components/responses/SocketForbidden'
'404':
$ref: '#/components/responses/SocketNotFoundResponse'
'429':
$ref: '#/components/responses/SocketTooManyRequestsResponse'
x-readme: {}
/threat-feed:
get:
tags:
- deprecated
summary: Get Threat Feed Items (Deprecated)
deprecated: true
operationId: getThreatFeedItems
parameters:
- name: per_page
in: query
required: false
description: Number of threats per page
schema:
type: integer
minimum: 1
maximum: 100
default: 30
- name: page
in: query
required: false
description: Page token
schema:
type: string
default: '1'
- name: sort
in: query
required: false
description: Sort sort the threat feed by ID or createdAt attribute.
schema:
type: string
enum:
- id
- created_at
default: id
- name: discovery_period
in: query
required: false
description: Filter results by discovery period
schema:
type: string
enum:
- 1h
- 6h
- 1d
- 7d
- 30d
- 90d
- 365d
- name: direction
in: query
required: false
description: Ordering direction of the sort attribute
schema:
type: string
enum:
- desc
- asc
default: desc
- name: filter
in: query
required: false
description: 'Filter by threat classification. Supported values: `mal` (malware, including possible malware), `vuln` (vulnerability), `typo` (typosquat, including possible typosquat), `anom` (anomaly), `spy` (telemetry), `obf` (obfuscated code), `dual` (dual-use tool), `joke` (protestware or joke package), `tp` (all confirmed true positives), `fp` (false positive), `u` (unreviewed), `c` (classified, i.e. anything except unreviewed).'
schema:
type: string
enum:
- u
- c
- fp
- tp
- mal
- vuln
- anom
- joke
- spy
- typo
- obf
- dual
default: mal
- name: name
in: query
required: false
description: Filter threats by package name
schema:
type: string
default: ''
- name: version
in: query
required: false
description: Filter threats by package version
schema:
type: string
default: ''
- name: is_human_reviewed
in: query
required: false
description: Only return threats which have been human-reviewed
schema:
type: boolean
default: false
- name: ecosystem
in: query
required: false
description: Filter threats by package ecosystem.
schema:
type: string
enum:
- github
- cargo
- clawhub
- composer
- chrome
- golang
- huggingface
- maven
- npm
- nuget
- vscode
- pypi
- gem
- swift
security:
- bearerAuth:
- threat-feed:list
- basicAuth:
- threat-feed:list
description: '**This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/getorgthreatfeeditems) instead.
Paginated list of threat feed items.
This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https://socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
This endpoint consumes 1 unit of your quota.
This endpoint requires the following org token scopes:
- threat-feed:list'
responses:
'200':
content:
application/json:
schema:
type: object
additionalProperties: false
description: ''
properties:
results:
type: array
items:
type: object
additionalProperties: false
properties:
createdAt:
type: string
description: ISO 8601 timestamp of when the threat in the package artifact was first discovered
default: ''
format: date-time
updatedAt:
type: string
description: ISO 8601 timestamp of when the threat record for the package artifact was last updated (e.g., classification changed, package removed from registry, etc.)
default: ''
format: date-time
publishedAt:
type: string
description: ISO 8601 timestamp of when the package artifact was published to the respective registry
default: ''
format: date-time
nullable: true
description:
type: string
description: Detailed description of the underlying threat
default: ''
fileSha256:
type: string
description: Hex-encoded SHA-256 hash of the malicious file content, usable as an indicator of compromise (IOC). Null when no file content hash is available for the threat.
default: ''
nullable: true
id:
type: integer
description: Unique identifier of the threat feed entry
default: 0
locationHtmlUrl:
type: string
description: URL to the threat details page on Socket
default: ''
format: uri
packageHtmlUrl:
type: string
description: URL to the affected package page on Socket
default: ''
format: uri
purl:
type: string
description: Package URL (PURL) of the affected package artifact
default: ''
removedAt:
type: string
description: ISO 8601 timestamp of when the package artifact was removed from the respective registry, or null if the package is still available on the registry
default: ''
format: date-time
nullable: true
threatType:
type: string
description: 'Threat classification. Possible values: `malware` (known malware), `possible_malware` (AI-detected potential malware), `vulnerability` (potential vulnerability), `typosquat` (human-reviewed typosquat), `possible_typosquat` (AI-detected potential typosquat), `anomaly` (anomalous behavior), `telemetry` (telemetry), `obfuscated` (obfuscated code), `dual_use` (dual-use tool), `troll` (protestware or joke package), `unreviewed` (not yet reviewed), `false_positive` (confirmed false positive).'
default: ''
needsHumanReview:
type:
# --- truncated at 32 KB (294 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/socket/refs/heads/main/openapi/socket-deprecated-api-openapi.yml