Snyk
Snyk Cloud API

The Cloud API from Snyk — 6 operation(s) for cloud.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.3
info:
  title: Snyk AccessRequests Cloud API
  version: REST
servers:
- description: Snyk REST API
  url: https://api.snyk.io/rest
security:
- APIToken: []
- BearerAuth: []
tags:
- name: Cloud
paths:
  /orgs/{org_id}/cloud/environments:
    get:
      description: 'List environments for an organization


        #### Required permissions


        - `View environments (org.cloud_environments.read)`'
      operationId: listEnvironments
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Organization ID
        example: 9a46d918-8764-458c-1234-0987abcd6543
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/CreatedAfter'
      - $ref: '#/components/parameters/CreatedBefore'
      - $ref: '#/components/parameters/UpdatedAfter'
      - $ref: '#/components/parameters/UpdatedBefore'
      - $ref: '#/components/parameters/NameInQuery'
      - $ref: '#/components/parameters/KindInQuery'
      - $ref: '#/components/parameters/StatusInQuery'
      - $ref: '#/components/parameters/IdInQuery'
      - description: Filter environments by project ID
        example: 9a46d918-8764-458c-1234-0987abcd6543
        in: query
        name: project_id
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      properties:
                        attributes:
                          $ref: '#/components/schemas/EnvironmentAttributes'
                        id:
                          description: Environment ID
                          example: d5b640e5-d88c-4c17-9bf0-93597b7a1ce2
                          format: uuid
                          type: string
                        relationships:
                          $ref: '#/components/schemas/EnvironmentRelationships'
                        type:
                          $ref: '#/components/schemas/EnvironmentType'
                      required:
                      - id
                      - type
                      type: object
                    type: array
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/PaginatedLinks'
                type: object
          description: Returns a list of environments
          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'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: List Environments (Early Access)
      tags:
      - Cloud
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2022-04-13~experimental
      - 2022-12-21~beta
      - 2023-10-19~beta
      x-snyk-api-resource: environments
      x-snyk-api-stability: beta
      x-snyk-api-version: 2023-10-19~beta
      x-stability-level: beta
    post:
      description: 'Create a new environment and run a scan


        #### Required permissions


        - `Create environments (org.cloud_environments.create)`'
      operationId: createEnvironment
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Organization ID
        example: 9a46d918-8764-458c-1234-0987abcd6543
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  additionalProperties: false
                  properties:
                    attributes:
                      $ref: '#/components/schemas/EnvironmentCreateAttributes'
                    type:
                      $ref: '#/components/schemas/EnvironmentType'
                  required:
                  - type
                  type: object
              required:
              - data
              type: object
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    additionalProperties: false
                    description: Environment resource object
                    properties:
                      attributes:
                        $ref: '#/components/schemas/EnvironmentAttributes'
                      id:
                        description: Environment ID
                        example: d5b640e5-d88c-4c17-9bf0-93597b7a1ce2
                        format: uuid
                        type: string
                      relationships:
                        $ref: '#/components/schemas/EnvironmentRelationships'
                      type:
                        $ref: '#/components/schemas/EnvironmentType'
                    required:
                    - id
                    - type
                    type: object
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/PaginatedLinks'
          description: Created environment successfully
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            location:
              $ref: '#/components/headers/LocationHeader'
            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'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: Create New Environment (Early Access)
      tags:
      - Cloud
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2022-04-13~experimental
      - 2022-12-21~beta
      - 2023-10-19~beta
      x-snyk-api-resource: environments
      x-snyk-api-stability: beta
      x-snyk-api-version: 2023-10-19~beta
      x-stability-level: beta
  /orgs/{org_id}/cloud/environments/{environment_id}:
    delete:
      description: 'Delete an environment


        #### Required permissions


        - `Delete environments (org.cloud_environments.delete)`'
      operationId: deleteEnvironment
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Organization ID
        example: 9a46d918-8764-458c-1234-0987abcd6543
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/EnvironmentId'
      responses:
        '204':
          description: Returns an empty response
          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'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: Delete Environment (Early Access)
      tags:
      - Cloud
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2022-04-13~experimental
      - 2022-12-21~beta
      - 2023-10-19~beta
      x-snyk-api-resource: environments
      x-snyk-api-stability: beta
      x-snyk-api-version: 2023-10-19~beta
      x-stability-level: beta
    patch:
      description: 'Update an environment


        #### Required permissions


        - `Update environments (org.cloud_environments.edit)`'
      operationId: updateEnvironment
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Organization ID
        example: 9a46d918-8764-458c-1234-0987abcd6543
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/EnvironmentId'
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  additionalProperties: false
                  properties:
                    attributes:
                      $ref: '#/components/schemas/EnvironmentUpdateAttributes'
                    id:
                      example: d5b640e5-d88c-4c17-9bf0-93597b7a1ce2
                      format: uuid
                      type: string
                    type:
                      $ref: '#/components/schemas/EnvironmentType'
                  required:
                  - id
                  - type
                  type: object
              required:
              - data
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    additionalProperties: false
                    description: environment resource object
                    properties:
                      attributes:
                        $ref: '#/components/schemas/EnvironmentAttributes'
                      id:
                        example: d5b640e5-d88c-4c17-9bf0-93597b7a1ce2
                        format: uuid
                        type: string
                      relationships:
                        $ref: '#/components/schemas/EnvironmentRelationships'
                      type:
                        $ref: '#/components/schemas/EnvironmentType'
                    required:
                    - id
                    - type
                    type: object
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/PaginatedLinks'
                type: object
          description: Updated an environment successfully
          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'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: Update Environment (Early Access)
      tags:
      - Cloud
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2022-04-13~experimental
      - 2022-12-21~beta
      - 2023-10-19~beta
      x-snyk-api-resource: environments
      x-snyk-api-stability: beta
      x-snyk-api-version: 2023-10-19~beta
      x-stability-level: beta
  /orgs/{org_id}/cloud/permissions:
    post:
      description: 'Generate IAC template for Snyk to access your cloud resources


        #### Required permissions


        - `Create environments (org.cloud_environments.create)`'
      operationId: getPermissions
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Organization ID
        example: 9a46d918-8764-458c-1234-0987abcd6543
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  additionalProperties: false
                  properties:
                    attributes:
                      $ref: '#/components/schemas/CreatePermissionsAttributes'
                    type:
                      example: permission
                      type: string
                  required:
                  - type
                  - attributes
                  type: object
              required:
              - data
              type: object
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    additionalProperties: false
                    description: permissions resource object
                    properties:
                      attributes:
                        $ref: '#/components/schemas/PermissionsAttributes'
                      id:
                        example: d5b640e5-d88c-4c17-9bf0-93597b7a1ce2
                        format: uuid
                        type: string
                      type:
                        example: permission
                        type: string
                    required:
                    - attributes
                    - id
                    - type
                    type: object
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/PaginatedLinks'
          description: Created permissions successfully
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            location:
              $ref: '#/components/headers/LocationHeader'
            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'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: Generate Cloud Provider Permissions (Early Access)
      tags:
      - Cloud
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2022-04-13~experimental
      - 2022-12-21~beta
      - 2023-10-19~beta
      x-snyk-api-resource: permissions
      x-snyk-api-stability: beta
      x-snyk-api-version: 2023-10-19~beta
      x-stability-level: beta
  /orgs/{org_id}/cloud/resources:
    get:
      description: 'List resources for an organization


        #### Required permissions


        - `View resources (org.cloud_resources.read)`'
      operationId: listResources
      parameters:
      - description: Organization ID
        example: 9a46d918-8764-458c-1234-0987abcd6543
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/EnvironmentIdQuery'
      - $ref: '#/components/parameters/ResourceType'
      - $ref: '#/components/parameters/ResourceId'
      - $ref: '#/components/parameters/NativeId'
      - $ref: '#/components/parameters/Id'
      - $ref: '#/components/parameters/Platform'
      - $ref: '#/components/parameters/Name'
      - $ref: '#/components/parameters/Kind'
      - $ref: '#/components/parameters/Location'
      - $ref: '#/components/parameters/Removed'
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      properties:
                        attributes:
                          $ref: '#/components/schemas/ResourceAttributes'
                        id:
                          example: d5b640e5-d88c-4c17-9bf0-93597b7a1ce2
                          format: uuid
                          type: string
                        relationships:
                          $ref: '#/components/schemas/ResourceRelationships'
                        type:
                          example: resource
                          type: string
                      required:
                      - id
                      - type
                      type: object
                    type: array
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/PaginatedLinks'
                type: object
          description: Returns a list of resources
          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'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: List Resources (Early Access)
      tags:
      - Cloud
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2022-04-13~experimental
      - 2022-12-21~beta
      - 2023-10-19~beta
      x-snyk-api-resource: resources
      x-snyk-api-stability: beta
      x-snyk-api-version: 2023-10-19~beta
      x-stability-level: beta
  /orgs/{org_id}/cloud/scans:
    get:
      description: 'List scans for an organization


        #### Required permissions


        - `View scans (org.cloud_scans.read)`'
      operationId: listScan
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      - description: Organization ID
        example: 9a46d918-8764-458c-1234-0987abcd6543
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      properties:
                        attributes:
                          $ref: '#/components/schemas/ScanAttributes'
                        id:
                          description: Scan ID
                          example: d5b640e5-d88c-4c17-9bf0-93597b7a1ce2
                          format: uuid
                          type: string
                        relationships:
                          $ref: '#/components/schemas/ScanRelationships'
                        type:
                          $ref: '#/components/schemas/ScanType'
                      required:
                      - id
                      - type
                      type: object
                    type: array
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/PaginatedLinks'
                type: object
          description: Returns a list of scan instances
          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'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: List Scans (Early Access)
      tags:
      - Cloud
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2022-04-13~experimental
      - 2022-12-21~beta
      x-snyk-api-resource: scans
      x-snyk-api-stability: beta
      x-snyk-api-version: 2022-12-21~beta
      x-stability-level: beta
    post:
      description: 'Create and trigger a new scan for an environment


        #### Required permissions


        - `Create scans (org.cloud_scans.create)`'
      operationId: createScan
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Organization ID
        example: 9a46d918-8764-458c-1234-0987abcd6543
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  additionalProperties: false
                  properties:
                    attributes:
                      $ref: '#/components/schemas/ScanCreateAttributes'
                    relationships:
                      $ref: '#/components/schemas/ScanCreateRelationships'
                    type:
                      $ref: '#/components/schemas/ScanType'
                  required:
                  - type
                  type: object
              required:
              - data
              type: object
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    additionalProperties: false
                    description: Scan resource object
                    properties:
                      attributes:
                        $ref: '#/components/schemas/ScanAttributes'
                      id:
                        description: Scan ID
                        example: d5b640e5-d88c-4c17-9bf0-93597b7a1ce2
                        format: uuid
                        type: string
                      relationships:
                        $ref: '#/components/schemas/ScanRelationships'
                      type:
                        $ref: '#/components/schemas/ScanType'
                    required:
                    - id
                    - type
                    type: object
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/PaginatedLinks'
          description: Created scan successfully
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            location:
              $ref: '#/components/headers/LocationHeader'
            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'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: Create Scan (Early Access)
      tags:
      - Cloud
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2022-04-13~experimental
      - 2022-12-21~beta
      x-snyk-api-resource: scans
      x-snyk-api-stability: beta
      x-snyk-api-version: 2022-12-21~beta
      x-stability-level: beta
  /orgs/{org_id}/cloud/scans/{scan_id}:
    get:
      description: 'Get a single scan for an organization


        #### Required permissions


        - `View scans (org.cloud_scans.read)`'
      operationId: getScan
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Organization ID
        example: 9a46d918-8764-458c-1234-0987abcd6543
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/ScanId'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/ScanAttributes'
                      id:
                        description: Scan ID
                        example: d5b640e5-d88c-4c17-9bf0-93597b7a1ce2
                        format: uuid
                        type: string
                      relationships:
                        $ref: '#/components/schemas/ScanRelationships'
                      type:
                        $ref: '#/components/schemas/ScanType'
                    required:
                    - id
                    - type
                    type: object
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/PaginatedLinks'
                type: object
          description: Returns a single scan instance
          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'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: Get scan (Early Access)
      tags:
      - Cloud
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2022-12-21~beta
      x-snyk-api-resource: scans
      x-snyk-api-stability: beta
      x-snyk-api-version: 2022-12-21~beta
      x-stability-level: beta
components:
  schemas:
    PermissionType:
      enum:
      - cf
      - tf
      - bash
      type: string
    PlatformType:
      enum:
      - aws
      - azure
      - google
      type: string
    EnvironmentRelationships:
      additionalProperties: true
      description: Environment relationships
      example:
        organization:
          data:
            id: 00000000-0000-0000-0000-000000000000
            type: organization
          links:
            related: /path/to/<related resource>/<related-id>?version=<resolved version>&...
        project:
          data:
            id: 11111111-1111-11111-1111-111111111111
            type: project
      type: object
    EnvironmentUpdateAttributes:
      description: Environment update attributes. Only the AWS role ARN can be updated; new ARN must have the same account ID as the old ARN.
      example:
        options:
          role_arn: arn:aws:iam::123456789012:role/SnykCloud1234
      properties:
        name:
          $ref: '#/components/schemas/EnvironmentName'
        options:
          $ref: '#/components/schemas/EnvironmentOptions'
      required:
      - options
      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
    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
    AzureOptions:
      description: Options for generating an Azure environment permissions script
      example:
        subscription_id: 6884d000-8dd4-11ed-a1eb-0242ac120002
        tenant_id: 51627f08-8dd4-11ed-a1eb-0242ac120002
      properties:
        subscription_id:
          description: ID of the Azure subscription to be scanned
          example: 6884d000-8dd4-11ed-a1eb-0242ac120002
          type: string
        tenant_id:
          description: Azure Tenant (directory) ID
          example: 51627f08-8dd4-11ed-a1eb-0242ac120002
          type: string
      required:
      - tenant_id
      - 

# --- truncated at 32 KB (64 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/openapi/snyk-cloud-api-openapi.yml
Snyk Cloud API

Documentation

Specifications

Other Resources

OpenAPI Specification
