v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

Describes an existing model defined for a RestApi resource.

get/restapis/{restapi_id}/models/{model_name}

Path parameters

restapi_idstring required

The RestApi identifier under which the Model exists.

model_namestring required

The name of the model as an identifier.

Query parameters

flattenboolean

A query parameter of a Boolean value to resolve (<code>true</code>) all external model references and returns a flattened model schema or not (<code>false</code>) The default is <code>false</code>.

Response

Success

idstring

The identifier for the model resource.

namestring

The name of the model. Must be an alphanumeric string.

descriptionstring

The description of the model.

schemastring

The schema for the model. For <code>application/json</code> models, this should be JSON schema draft 4 model. Do not include "*/" characters in the description of any properties because such "*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

contentTypestring

The content-type for the model.