Snyk
Snyk LanguagesSettings API

The LanguagesSettings API from Snyk — 2 operation(s) for languagessettings.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.3
info:
  title: Snyk AccessRequests LanguagesSettings API
  version: REST
servers:
- description: Snyk REST API
  url: https://api.snyk.io/rest
security:
- APIToken: []
- BearerAuth: []
tags:
- name: LanguagesSettings
paths:
  /orgs/{org_id}/settings/open_source/languages:
    get:
      description: 'Retrieves the language settings for a specific organization.


        #### Required permissions


        - `View Organization (org.read)`'
      operationId: getOrgLanguagesSettings
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: The id of the org for which we want to update the Snyk Languages settings
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    $ref: '#/components/schemas/LanguagesSettingsResponse'
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/Links'
                required:
                - jsonapi
                - data
                - links
                type: object
          description: The Languages settings for the org
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Get language settings for an organization (Early Access)
      tags:
      - LanguagesSettings
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2024-08-25~beta
      x-snyk-api-resource: languages_settings
      x-snyk-api-stability: beta
      x-snyk-api-version: 2024-08-25~beta
      x-stability-level: beta
  /orgs/{org_id}/settings/open_source/languages/{language}:
    patch:
      description: 'Updates one or more language settings for a specific organization.


        #### Required permissions


        - `View Organization (org.read)`


        - `Edit Organization (org.edit)`'
      operationId: updateOrgLanguagesSettings
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: The id of the org for which we want to update the Snyk Languages settings
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - description: The language for which settings are being updated
        in: path
        name: language
        required: true
        schema:
          enum:
          - javascript
          - python
          - dotnet
          - php
          - golang
          - java
          type: string
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  $ref: '#/components/schemas/LanguagesSettingsUpdateRequest'
              required:
              - data
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    $ref: '#/components/schemas/LanguagesSettingsResponse'
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/Links'
                required:
                - jsonapi
                - data
                - links
                type: object
          description: The Languages settings for the org have been updated
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Update language settings for an organization (Early Access)
      tags:
      - LanguagesSettings
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2024-08-25~beta
      x-snyk-api-resource: languages_settings
      x-snyk-api-stability: beta
      x-snyk-api-version: 2024-08-25~beta
      x-stability-level: beta
components:
  parameters:
    EndingBefore:
      description: Return the page of results immediately before this cursor
      example: v1.eyJpZCI6IjExMDAifQo=
      in: query
      name: ending_before
      schema:
        type: string
    StartingAfter:
      description: Return the page of results immediately after this cursor
      example: v1.eyJpZCI6IjEwMDAifQo=
      in: query
      name: starting_after
      schema:
        type: string
    Version:
      description: The requested version of the endpoint to process the request
      example: '2026-03-25'
      in: query
      name: version
      required: true
      schema:
        $ref: '#/components/schemas/QueryVersion'
    Limit:
      description: Number of results to return per page
      example: 10
      in: query
      name: limit
      schema:
        default: 10
        format: int32
        maximum: 100
        minimum: 10
        multipleOf: 10
        type: integer
  schemas:
    JavascriptSettings:
      additionalProperties: false
      properties:
        npm:
          $ref: '#/components/schemas/NodeSettings'
        pnpm:
          $ref: '#/components/schemas/NodeSettings'
        yarn:
          $ref: '#/components/schemas/NodeSettings'
      type: object
    ActualVersion:
      description: Resolved API version
      example: '2026-03-25'
      pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$
      type: string
    ComposerSettings:
      additionalProperties: false
      properties:
        include_dev_dependencies:
          type: boolean
      required:
      - include_dev_dependencies
      type: object
    PackageRepository:
      additionalProperties: true
      properties:
        integration_type:
          enum:
          - artifactory
          - nexus
          type: string
        repository:
          type: string
        type:
          enum:
          - direct
          - integration
          type: string
        url:
          description: used for display purpose only
          type: string
      required:
      - type
      - repository
      type: object
    JsonApi:
      additionalProperties: false
      example:
        version: '1.0'
      properties:
        version:
          description: Version of the JSON API specification this server supports.
          example: '1.0'
          pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$
          type: string
      required:
      - version
      type: object
    LanguagesSettingsUpdateRequest:
      properties:
        attributes:
          $ref: '#/components/schemas/LanguageSettings'
        id:
          description: The organization's public ID.
          format: uuid
          type: string
        type:
          enum:
          - language_settings
          type: string
      required:
      - type
      - id
      - attributes
      type: object
    PhpSettings:
      additionalProperties: false
      properties:
        composer:
          $ref: '#/components/schemas/ComposerSettings'
      type: object
    GoSettings:
      additionalProperties: false
      properties:
        gomodules:
          $ref: '#/components/schemas/GolangModulesSettings'
      type: object
    LanguageSettings:
      additionalProperties: false
      properties:
        package_managers:
          oneOf:
          - $ref: '#/components/schemas/JavascriptSettings'
          - $ref: '#/components/schemas/PythonSettings'
          - $ref: '#/components/schemas/DotnetSettings'
          - $ref: '#/components/schemas/PhpSettings'
          - $ref: '#/components/schemas/GoSettings'
          - $ref: '#/components/schemas/JavaSettings'
      required:
      - package_managers
      type: object
    NodeSettings:
      additionalProperties: true
      properties:
        exclude_lockfile_in_pr:
          type: boolean
        include_dev_dependencies:
          type: boolean
        registries:
          items:
            $ref: '#/components/schemas/NodePackageRegistry'
          type: array
        strict_out_of_sync:
          type: boolean
      required:
      - include_dev_dependencies
      - strict_out_of_sync
      - exclude_lockfile_in_pr
      type: object
    QueryVersion:
      description: Requested API version
      example: '2026-03-25'
      pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
      type: string
    LanguagesSettings:
      additionalProperties: false
      properties:
        languages:
          additionalProperties: false
          properties:
            dotnet:
              $ref: '#/components/schemas/DotnetSettings'
            golang:
              $ref: '#/components/schemas/GoSettings'
            java:
              $ref: '#/components/schemas/JavaSettings'
            javascript:
              $ref: '#/components/schemas/JavascriptSettings'
            php:
              $ref: '#/components/schemas/PhpSettings'
            python:
              $ref: '#/components/schemas/PythonSettings'
          required:
          - javascript
          - python
          - dotnet
          - php
          - golang
          - java
          type: object
      required:
      - languages
      type: object
    GolangModulesSettings:
      additionalProperties: false
      properties:
        full_source_code_analysis:
          type: boolean
      required:
      - full_source_code_analysis
      type: object
    JavaSettings:
      additionalProperties: false
      properties:
        maven:
          $ref: '#/components/schemas/MavenSettings'
      type: object
    MirrorRepository:
      allOf:
      - $ref: '#/components/schemas/PackageRepository'
      - properties:
          mirror_of:
            type: string
        required:
        - mirror_of
        type: object
    ErrorDocument:
      additionalProperties: false
      example:
        errors:
        - detail: Permission denied for this resource
          status: '403'
        jsonapi:
          version: '1.0'
      properties:
        errors:
          example:
          - detail: Permission denied for this resource
            status: '403'
          items:
            additionalProperties: false
            example:
              detail: Not Found
              status: '404'
            properties:
              code:
                description: An application-specific error code, expressed as a string value.
                example: entity-not-found
                type: string
              detail:
                description: A human-readable explanation specific to this occurrence of the problem.
                example: 'The request was missing these required fields: ...'
                type: string
              id:
                description: A unique identifier for this particular occurrence of the problem.
                example: f16c31b5-6129-4571-add8-d589da9be524
                format: uuid
                type: string
              links:
                additionalProperties: false
                description: A link that leads to further details about this particular occurrance of the problem.
                example:
                  about: https://example.com/about_this_error
                properties:
                  about:
                    example: https://example.com/api/resource
                    oneOf:
                    - description: A string containing the link’s URL.
                      example: https://example.com/api/resource
                      type: string
                    - additionalProperties: false
                      example:
                        href: https://example.com/api/resource
                      properties:
                        href:
                          description: A string containing the link’s URL.
                          example: https://example.com/api/resource
                          type: string
                        meta:
                          additionalProperties: true
                          description: Free-form object that may contain non-standard information.
                          example:
                            key1: value1
                            key2:
                              sub_key: sub_value
                            key3:
                            - array_value1
                            - array_value2
                          type: object
                      required:
                      - href
                      type: object
                type: object
              meta:
                additionalProperties: true
                example:
                  key: value
                type: object
              source:
                additionalProperties: false
                example:
                  pointer: /data/attributes
                properties:
                  parameter:
                    description: A string indicating which URI query parameter caused the error.
                    example: param1
                    type: string
                  pointer:
                    description: A JSON Pointer [RFC6901] to the associated entity in the request document.
                    example: /data/attributes
                    type: string
                type: object
              status:
                description: The HTTP status code applicable to this problem, expressed as a string value.
                example: '400'
                pattern: ^[45]\d\d$
                type: string
              title:
                description: A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
                example: Bad request
                type: string
            required:
            - status
            - detail
            type: object
          minItems: 1
          type: array
        jsonapi:
          additionalProperties: false
          example:
            version: '1.0'
          properties:
            version:
              description: Version of the JSON API specification this server supports.
              example: '1.0'
              pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$
              type: string
          required:
          - version
          type: object
      required:
      - jsonapi
      - errors
      type: object
    DotnetSettings:
      additionalProperties: false
      properties:
        nuget:
          $ref: '#/components/schemas/NugetSettings'
      type: object
    PipSettings:
      additionalProperties: false
      properties:
        python_version:
          enum:
          - '2'
          - '3'
          - '3.8'
          - '3.9'
          - '3.10'
          - '3.11'
          - '3.12'
          - '3.13'
          - '3.14'
          type: string
      required:
      - python_version
      type: object
    PythonSettings:
      additionalProperties: false
      properties:
        pip:
          $ref: '#/components/schemas/PipSettings'
        pipenv:
          $ref: '#/components/schemas/PipenvSettings'
        poetry:
          $ref: '#/components/schemas/PoetrySettings'
      type: object
    MavenSettings:
      additionalProperties: false
      properties:
        mirrors:
          items:
            $ref: '#/components/schemas/MirrorRepository'
          type: array
        repositories:
          items:
            $ref: '#/components/schemas/PackageRepository'
          type: array
      required:
      - mirrors
      - repositories
      type: object
    NugetSettings:
      additionalProperties: false
      properties:
        include_dev_dependencies:
          type: boolean
      required:
      - include_dev_dependencies
      type: object
    PipenvSettings:
      additionalProperties: false
      properties:
        include_dev_dependencies:
          type: boolean
      required:
      - include_dev_dependencies
      type: object
    Links:
      additionalProperties: false
      properties:
        first:
          $ref: '#/components/schemas/LinkProperty'
        last:
          $ref: '#/components/schemas/LinkProperty'
        next:
          $ref: '#/components/schemas/LinkProperty'
        prev:
          $ref: '#/components/schemas/LinkProperty'
        related:
          $ref: '#/components/schemas/LinkProperty'
        self:
          $ref: '#/components/schemas/LinkProperty'
      type: object
    LanguagesSettingsResponse:
      additionalProperties: false
      properties:
        attributes:
          $ref: '#/components/schemas/LanguagesSettings'
        id:
          description: The organization's public ID.
          format: uuid
          type: string
        type:
          enum:
          - languages_settings
          type: string
      required:
      - type
      - id
      - attributes
      type: object
    NodePackageRegistry:
      additionalProperties: true
      allOf:
      - $ref: '#/components/schemas/PackageRepository'
      - properties:
          scope:
            type: string
        type: object
    PoetrySettings:
      additionalProperties: false
      properties:
        include_dev_dependencies:
          type: boolean
      required:
      - include_dev_dependencies
      type: object
    LinkProperty:
      example: https://example.com/api/resource
      oneOf:
      - description: A string containing the link’s URL.
        example: https://example.com/api/resource
        type: string
      - additionalProperties: false
        example:
          href: https://example.com/api/resource
        properties:
          href:
            description: A string containing the link’s URL.
            example: https://example.com/api/resource
            type: string
          meta:
            additionalProperties: true
            description: Free-form object that may contain non-standard information.
            example:
              key1: value1
              key2:
                sub_key: sub_value
              key3:
              - array_value1
              - array_value2
            type: object
        required:
        - href
        type: object
  headers:
    SunsetHeader:
      description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD'
      example: '2021-08-02'
      schema:
        format: date
        type: string
    VersionRequestedResponseHeader:
      description: A header containing the version of the endpoint requested by the caller.
      example: '2026-03-25'
      schema:
        $ref: '#/components/schemas/QueryVersion'
    VersionServedResponseHeader:
      description: A header containing the version of the endpoint that was served by the API.
      example: '2026-03-25'
      schema:
        $ref: '#/components/schemas/ActualVersion'
    VersionStageResponseHeader:
      description: 'A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.

        '
      schema:
        enum:
        - wip
        - experimental
        - beta
        - ga
        - deprecated
        - sunset
        example: ga
        type: string
    RequestIdResponseHeader:
      description: 'A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID.

        '
      example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef
      schema:
        format: uuid
        type: string
    DeprecationHeader:
      description: 'A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:

        https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html

        '
      example: '2021-07-01T00:00:00Z'
      schema:
        format: date-time
        type: string
  responses:
    '400':
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorDocument'
      description: 'Bad Request: A parameter provided as a part of the request was invalid.'
      headers:
        deprecation:
          $ref: '#/components/headers/DeprecationHeader'
        snyk-request-id:
          $ref: '#/components/headers/RequestIdResponseHeader'
        snyk-version-lifecycle-stage:
          $ref: '#/components/headers/VersionStageResponseHeader'
        snyk-version-requested:
          $ref: '#/components/headers/VersionRequestedResponseHeader'
        snyk-version-served:
          $ref: '#/components/headers/VersionServedResponseHeader'
        sunset:
          $ref: '#/components/headers/SunsetHeader'
    '500':
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorDocument'
      description: 'Internal Server Error: An error was encountered while attempting to process the request.'
      headers:
        deprecation:
          $ref: '#/components/headers/DeprecationHeader'
        snyk-request-id:
          $ref: '#/components/headers/RequestIdResponseHeader'
        snyk-version-lifecycle-stage:
          $ref: '#/components/headers/VersionStageResponseHeader'
        snyk-version-requested:
          $ref: '#/components/headers/VersionRequestedResponseHeader'
        snyk-version-served:
          $ref: '#/components/headers/VersionServedResponseHeader'
        sunset:
          $ref: '#/components/headers/SunsetHeader'
    '403':
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorDocument'
      description: 'Forbidden: the request requires an authentication token with more or different permissions.'
      headers:
        deprecation:
          $ref: '#/components/headers/DeprecationHeader'
        snyk-request-id:
          $ref: '#/components/headers/RequestIdResponseHeader'
        snyk-version-lifecycle-stage:
          $ref: '#/components/headers/VersionStageResponseHeader'
        snyk-version-requested:
          $ref: '#/components/headers/VersionRequestedResponseHeader'
        snyk-version-served:
          $ref: '#/components/headers/VersionServedResponseHeader'
        sunset:
          $ref: '#/components/headers/SunsetHeader'
    '404':
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorDocument'
      description: 'Not Found: The resource being operated on could not be found.'
      headers:
        deprecation:
          $ref: '#/components/headers/DeprecationHeader'
        snyk-request-id:
          $ref: '#/components/headers/RequestIdResponseHeader'
        snyk-version-lifecycle-stage:
          $ref: '#/components/headers/VersionStageResponseHeader'
        snyk-version-requested:
          $ref: '#/components/headers/VersionRequestedResponseHeader'
        snyk-version-served:
          $ref: '#/components/headers/VersionServedResponseHeader'
        sunset:
          $ref: '#/components/headers/SunsetHeader'
    '401':
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorDocument'
      description: 'Unauthorized: the request requires an authentication token.'
      headers:
        deprecation:
          $ref: '#/components/headers/DeprecationHeader'
        snyk-request-id:
          $ref: '#/components/headers/RequestIdResponseHeader'
        snyk-version-lifecycle-stage:
          $ref: '#/components/headers/VersionStageResponseHeader'
        snyk-version-requested:
          $ref: '#/components/headers/VersionRequestedResponseHeader'
        snyk-version-served:
          $ref: '#/components/headers/VersionServedResponseHeader'
        sunset:
          $ref: '#/components/headers/SunsetHeader'
  securitySchemes:
    APIToken:
      description: API key value must be prefixed with \"Token \".
      in: header
      name: Authorization
      type: apiKey
    BearerAuth:
      scheme: bearer
      type: http
x-snyk-api-version: '2024-10-15'
Snyk LanguagesSettings API

Documentation

Specifications

Other Resources

OpenAPI Specification
