Snowflake · Schema

ApiIntegration

A Snowflake API integration object.

Data LakesData SharingData WarehousingDatabaseSQL

Properties

Name Type Description
name string Name of the API integration.
api_allowed_prefixes array A comma-separated list of endpoints and resources that Snowflake can access.
api_blocked_prefixes array A comma-separated list of endpoints and resources that are not allowed to be called from Snowflake.
enabled boolean Whether the API integration is enabled.
comment string Comment for the API integration.
created_on string Date and time when the API integration was created.
View JSON Schema on GitHub

JSON Schema

api-integration-api-integration-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ApiIntegration",
  "type": "object",
  "description": "A Snowflake API integration object.",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the API integration."
    },
    "api_allowed_prefixes": {
      "type": "array",
      "description": "A comma-separated list of endpoints and resources that Snowflake can access."
    },
    "api_blocked_prefixes": {
      "type": "array",
      "description": "A comma-separated list of endpoints and resources that are not allowed to be called from Snowflake."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the API integration is enabled."
    },
    "comment": {
      "type": "string",
      "description": "Comment for the API integration."
    },
    "created_on": {
      "type": "string",
      "description": "Date and time when the API integration was created."
    }
  }
}