Snowflake

Snowflake Network Policy API

The Snowflake Network Policy API is a REST API that you can use to access, update, and perform certain actions on Network Policy resource in a Snowflake database.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/network-policy

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/openapi/network-policy.yaml

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/network-policy-context.jsonld
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/capabilities/network-policy-network-policy.yaml

OpenAPI Specification

network-policy.yaml Raw ↑ 
openapi: 3.0.0
servers:
- description: Snowflake REST Server
  url: https://org-account.snowflakecomputing.com
info:
  version: 0.0.1
  title: Snowflake Network Policy API
  description: The Snowflake Network Policy API is a REST API that you can use to access, update, and perform certain actions on Network Policy resource in a Snowflake database.
  contact:
    name: Snowflake, Inc.
    url: https://snowflake.com
    email: support@snowflake.com
paths:
  /api/v2/network-policies:
    get:
      summary: List Network Policies
      tags:
      - network-policy
      description: List network policies
      operationId: listNetworkPolicies
      parameters: []
      responses:
        '200':
          description: successful
          headers:
            X-Snowflake-Request-ID:
              $ref: common.yaml#/components/headers/X-Snowflake-Request-ID
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NetworkPolicy'
              examples:
                Listnetworkpolicies200Example:
                  summary: Default listNetworkPolicies 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    allowed_network_rule_list:
                    - example_value
                    blocked_network_rule_list:
                    - example_value
                    allowed_ip_list:
                    - example_value
                    blocked_ip_list:
                    - example_value
                    comment: example_value
                    created_on: '2026-01-15T10:30:00Z'
                    owner: example_value
                    owner_role_type: example_value
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      summary: Create a Network Policy
      tags:
      - network-policy
      description: Create a network policy
      operationId: createNetworkPolicy
      parameters:
      - $ref: common.yaml#/components/parameters/createMode
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkPolicy'
            examples:
              CreatenetworkpolicyRequestExample:
                summary: Default createNetworkPolicy request
                x-microcks-default: true
                value:
                  name: Example Title
                  allowed_network_rule_list:
                  - example_value
                  blocked_network_rule_list:
                  - example_value
                  allowed_ip_list:
                  - example_value
                  blocked_ip_list:
                  - example_value
                  comment: example_value
                  created_on: '2026-01-15T10:30:00Z'
                  owner: example_value
                  owner_role_type: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v2/network-policies/{name}:
    get:
      summary: Fetch a Network Policy
      tags:
      - network-policy
      description: Fetch a network policy
      operationId: fetchNetworkPolicy
      parameters:
      - $ref: common.yaml#/components/parameters/name
      responses:
        '200':
          description: successful
          headers:
            X-Snowflake-Request-ID:
              $ref: common.yaml#/components/headers/X-Snowflake-Request-ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkPolicy'
              examples:
                Fetchnetworkpolicy200Example:
                  summary: Default fetchNetworkPolicy 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    allowed_network_rule_list:
                    - example_value
                    blocked_network_rule_list:
                    - example_value
                    allowed_ip_list:
                    - example_value
                    blocked_ip_list:
                    - example_value
                    comment: example_value
                    created_on: '2026-01-15T10:30:00Z'
                    owner: example_value
                    owner_role_type: example_value
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      summary: Delete a Network Policy
      tags:
      - network-policy
      description: Delete a network policy
      operationId: deleteNetworkPolicy
      parameters:
      - $ref: common.yaml#/components/parameters/name
      - $ref: common.yaml#/components/parameters/ifExists
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    NetworkPolicy:
      type: object
      description: A Snowflake network policy
      properties:
        name:
          type: string
          pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$
          description: Name of the network policy
          example: Example Title
        allowed_network_rule_list:
          type: array
          items:
            type: string
          description: List of names of allowed network rules in a network policy
          example: []
        blocked_network_rule_list:
          type: array
          items:
            type: string
          description: List of names of blocked network rules in a network policy
          example: []
        allowed_ip_list:
          type: array
          items:
            type: string
          description: List of allowed IPs in a network policy
          example: []
        blocked_ip_list:
          type: array
          items:
            type: string
          description: List of blocked IPs in a network policy
          example: []
        comment:
          type: string
          description: user comment associated to an object in the dictionary
          example: example_value
        created_on:
          type: string
          format: date-time
          readOnly: true
          description: Date and time when the network policy was created.
          example: '2026-01-15T10:30:00Z'
        owner:
          type: string
          pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$
          readOnly: true
          description: Role that owns the network policy
          example: example_value
        owner_role_type:
          type: string
          pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$
          readOnly: true
          description: The type of role that owns the network policy
          example: example_value
      required:
      - name