Socket telemetry API
The telemetry API from Socket — 1 operation(s) for telemetry.
OpenAPI Specification
openapi: 3.0.0
info:
description: Specification of the Socket API endpoints
title: API Endpoints alerts telemetry API
version: '0'
servers:
- url: https://api.socket.dev/v0
tags:
- name: telemetry
paths:
/orgs/{org_slug}/telemetry/config:
get:
tags:
- telemetry
summary: Get Organization Telemetry Config
operationId: getOrgTelemetryConfig
parameters:
- name: org_slug
in: path
required: true
description: The slug of the organization
schema:
type: string
security:
- bearerAuth: []
- basicAuth: []
description: 'Retrieve the telemetry config of an organization.
This endpoint consumes 1 unit of your quota.
This endpoint requires the following org token scopes:'
responses:
'200':
content:
application/json:
schema:
type: object
additionalProperties: false
description: ''
properties:
telemetry:
type: object
additionalProperties: false
description: Telemetry configuration
properties:
enabled:
type: boolean
default: false
description: Telemetry enabled
required:
- enabled
required:
- telemetry
description: Retrieved telemetry config 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: {}
put:
tags:
- telemetry
summary: Update Telemetry Config
operationId: updateOrgTelemetryConfig
parameters:
- name: org_slug
in: path
required: true
description: The slug of the organization
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
default: false
description: Telemetry enabled
description: ''
required: false
security:
- bearerAuth:
- telemetry-policy:update
- basicAuth:
- telemetry-policy:update
description: 'Update the telemetry config of an organization.
This endpoint consumes 1 unit of your quota.
This endpoint requires the following org token scopes:
- telemetry-policy:update'
responses:
'200':
content:
application/json:
schema:
type: object
additionalProperties: false
description: ''
properties:
telemetry:
type: object
additionalProperties: false
description: Telemetry configuration
properties:
enabled:
type: boolean
default: false
description: Telemetry enabled
required:
- enabled
required:
- telemetry
description: Updated telemetry config 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: {}
components:
responses:
SocketForbidden:
content:
application/json:
schema:
type: object
additionalProperties: false
description: ''
properties:
error:
type: object
additionalProperties: false
description: ''
properties:
message:
type: string
description: ''
default: ''
details:
type: object
description: ''
default: null
nullable: true
required:
- details
- message
required:
- error
description: Insufficient max_quota for API method
SocketBadRequest:
content:
application/json:
schema:
type: object
additionalProperties: false
description: ''
properties:
error:
type: object
additionalProperties: false
description: ''
properties:
message:
type: string
description: ''
default: ''
details:
type: object
description: ''
default: null
nullable: true
required:
- details
- message
required:
- error
description: Bad request
SocketNotFoundResponse:
content:
application/json:
schema:
type: object
additionalProperties: false
description: ''
properties:
error:
type: object
additionalProperties: false
description: ''
properties:
message:
type: string
description: ''
default: ''
details:
type: object
description: ''
default: null
nullable: true
required:
- details
- message
required:
- error
description: Resource not found
SocketTooManyRequestsResponse:
description: Insufficient quota for API route
headers:
Retry-After:
description: 'Retry contacting the endpoint *at least* after seconds.
See https://tools.ietf.org/html/rfc7231#section-7.1.3'
schema:
format: int32
type: integer
content:
application/json:
schema:
type: object
additionalProperties: false
description: ''
properties:
error:
type: object
additionalProperties: false
description: ''
properties:
message:
type: string
description: ''
default: ''
details:
type: object
description: ''
default: null
nullable: true
required:
- details
- message
required:
- error
SocketUnauthorized:
content:
application/json:
schema:
type: object
additionalProperties: false
description: ''
properties:
error:
type: object
additionalProperties: false
description: ''
properties:
message:
type: string
description: ''
default: ''
details:
type: object
description: ''
default: null
nullable: true
required:
- details
- message
required:
- error
description: Unauthorized
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Organization Tokens can be passed as a Bearer token
basicAuth:
type: http
scheme: basic
description: Organization Tokens can be passed as the user field in basic auth