API definition import error troubleshooting

The following table lists the common error messages that you may encounter after importing an API definition file in API Gateway. Each error message has a corresponding description and a suggested solution.

Import errors
Error Description Solution
The <property> property at <pointer> pointer is not supported. API Gateway does not support the property in your API definition file. For the list of supported properties, see Supported API definition elements. The message is informational and no action is required. The property has not been imported, but other supported properties have been successfully reflected in the API definition.
Swagger/RAML version is not supported. API Gateway does not support the version of your Swagger or RAML API definition file. The currently supported versions are Swagger 2.0, Swagger 3.0, and RAML 0.8. Ensure that the version of your API definition file is either Swagger 2.0, Swagger 3.0, or RAML 0.8.
Invalid schema Your imported API definition is not a valid Swagger 2.0, Swagger 3.0, or RAML 0.8 file. Depending on your API definition file format, compare the file with either Swagger 2.0 schema, Swagger 3.0 schema, or RAML 0.8 specification. Resolve the validation errors and reimport the API definition.
Invalid syntax This error can indicate two different issues:
  • At least one file in your imported API definition has an incorrect format. The supported file formats are json and yaml.
  • Your API definition file does not specify the Swagger or RAML version it represents.
Ensure that your files have correct formats and that they specify the Swagger or RAML version.
Unable to load ref: <ref> This error can indicate two different issues:
  • The URL you entered in the Import API window does not point to a valid API definition file.
  • When you’re importing a ZIP file, the specified Root file name does not correspond to any file in your API definition.
Ensure that the URL you entered points to a valid API definition file and, in case of a ZIP file upload, the Root file name points to the appropriate root file.
Parameters with multiple type not supported API Gateway only supports parameter definitions that specify a single type of a parameter. Find the multi-type parameters in your schema files, for example, by searching by the following phrase: "type": [ and change them to single-type. Reimport the API definition file.